Package Classes (0.2.7)

This service provides all methods related to the API hub.

A pager for iterating through list_api_operations requests.

This class thinly wraps an initial ListApiOperationsResponse object, and provides an __iter__ method to iterate through its api_operations field.

If there are more pages, the __iter__ method will make additional ListApiOperations requests and continue to iterate through the api_operations field on the corresponding responses.

All the usual ListApiOperationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_apis requests.

This class thinly wraps an initial ListApisResponse object, and provides an __iter__ method to iterate through its apis field.

If there are more pages, the __iter__ method will make additional ListApis requests and continue to iterate through the apis field on the corresponding responses.

All the usual ListApisResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_attributes requests.

This class thinly wraps an initial ListAttributesResponse object, and provides an __iter__ method to iterate through its attributes field.

If there are more pages, the __iter__ method will make additional ListAttributes requests and continue to iterate through the attributes field on the corresponding responses.

All the usual ListAttributesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __iter__ method to iterate through its deployments field.

If there are more pages, the __iter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_external_apis requests.

This class thinly wraps an initial ListExternalApisResponse object, and provides an __iter__ method to iterate through its external_apis field.

If there are more pages, the __iter__ method will make additional ListExternalApis requests and continue to iterate through the external_apis field on the corresponding responses.

All the usual ListExternalApisResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_specs requests.

This class thinly wraps an initial ListSpecsResponse object, and provides an __iter__ method to iterate through its specs field.

If there are more pages, the __iter__ method will make additional ListSpecs requests and continue to iterate through the specs field on the corresponding responses.

All the usual ListSpecsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_versions requests.

This class thinly wraps an initial ListVersionsResponse object, and provides an __iter__ method to iterate through its versions field.

If there are more pages, the __iter__ method will make additional ListVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_resources requests.

This class thinly wraps an initial SearchResourcesResponse object, and provides an __iter__ method to iterate through its search_results field.

If there are more pages, the __iter__ method will make additional SearchResources requests and continue to iterate through the search_results field on the corresponding responses.

All the usual SearchResourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service exposes methods used for collecting various types of data from different first party and third party sources and push it to Hub's collect layer.

This service is used for managing curations for processing API data consumed from collect layer.

A pager for iterating through list_curations requests.

This class thinly wraps an initial ListCurationsResponse object, and provides an __iter__ method to iterate through its curations field.

If there are more pages, the __iter__ method will make additional ListCurations requests and continue to iterate through the curations field on the corresponding responses.

All the usual ListCurationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service provides methods for various operations related to a Dependency in the API hub.

A pager for iterating through list_dependencies requests.

This class thinly wraps an initial ListDependenciesResponse object, and provides an __iter__ method to iterate through its dependencies field.

If there are more pages, the __iter__ method will make additional ListDependencies requests and continue to iterate through the dependencies field on the corresponding responses.

All the usual ListDependenciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service exposes methods used to manage DiscoveredApiObservations and DiscoveredApiOperations.

A pager for iterating through list_discovered_api_observations requests.

This class thinly wraps an initial ListDiscoveredApiObservationsResponse object, and provides an __iter__ method to iterate through its discovered_api_observations field.

If there are more pages, the __iter__ method will make additional ListDiscoveredApiObservations requests and continue to iterate through the discovered_api_observations field on the corresponding responses.

All the usual ListDiscoveredApiObservationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_discovered_api_operations requests.

This class thinly wraps an initial ListDiscoveredApiOperationsResponse object, and provides an __iter__ method to iterate through its discovered_api_operations field.

If there are more pages, the __iter__ method will make additional ListDiscoveredApiOperations requests and continue to iterate through the discovered_api_operations field on the corresponding responses.

All the usual ListDiscoveredApiOperationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service is used for managing plugins inside the API Hub.

A pager for iterating through list_plugin_instances requests.

This class thinly wraps an initial ListPluginInstancesResponse object, and provides an __iter__ method to iterate through its plugin_instances field.

If there are more pages, the __iter__ method will make additional ListPluginInstances requests and continue to iterate through the plugin_instances field on the corresponding responses.

All the usual ListPluginInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_plugins requests.

This class thinly wraps an initial ListPluginsResponse object, and provides an __iter__ method to iterate through its plugins field.

If there are more pages, the __iter__ method will make additional ListPlugins requests and continue to iterate through the plugins field on the corresponding responses.

All the usual ListPluginsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service is used for managing the host project registrations.

A pager for iterating through list_host_project_registrations requests.

This class thinly wraps an initial ListHostProjectRegistrationsResponse object, and provides an __iter__ method to iterate through its host_project_registrations field.

If there are more pages, the __iter__ method will make additional ListHostProjectRegistrations requests and continue to iterate through the host_project_registrations field on the corresponding responses.

All the usual ListHostProjectRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service provides all methods related to the 1p Linter.

This service is used for managing the data plane provisioning of the API hub.

This service is used for managing the runtime project attachments.

A pager for iterating through list_runtime_project_attachments requests.

This class thinly wraps an initial ListRuntimeProjectAttachmentsResponse object, and provides an __iter__ method to iterate through its runtime_project_attachments field.

If there are more pages, the __iter__ method will make additional ListRuntimeProjectAttachments requests and continue to iterate through the runtime_project_attachments field on the corresponding responses.

All the usual ListRuntimeProjectAttachmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

The API metadata.

The details for the action to execute.

Enum for the action type.

An API resource in the API Hub.

The abstract base class for a message.

The API data to be collected.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.

Available configurations to provision an ApiHub Instance.

Types of data encryption.

The abstract base class for a message.

State of the ApiHub Instance.

ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The message to hold repeated API metadata.

Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.

The abstract base class for a message.

The details of the Application Integration endpoint to be triggered for curation.

An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.

The value that can be assigned to the attribute when the data type is enum.

Enumeration of attribute's data type.

Enumeration of attribute definition types.

Enumeration for the scope of the attribute representing the resource in the API Hub to which the attribute can be linked.

The attribute values associated with resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The attribute values of data type enum.

The attribute values of data type string or JSON.

AuthConfig represents the authentication information.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Config for authentication with API key.

Enum of location an HTTP element can be.

Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.

Parameters to support Username and Password Authentication.

AuthType represents the authentication type.

The CollectApiData method's request.

The CollectApiData method's response.

The type of the collect request.

ConfigValueOption represents an option for a config variable of type enum or multi select.

ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The config variable value of data type multi int.

The config variable value of data type multi select.

The config variable value of data type multi string.

ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.

ValueType indicates the data type of the value.

The CreateApiHubInstance method's request.

The CreateApiOperation method's request.

The CreateApi method's request.

The CreateAttribute method's request.

The CreateCuration][ApiHub.CreateCuration] method's request.

The CreateDependency method's request.

The CreateDeployment method's request.

The CreateExternalApi method's request.

The CreateHostProjectRegistration method's request.

The CreatePluginInstance method's request.

The CreatePlugin method's request.

The CreateRuntimeProjectAttachment method's request.

The CreateSpec method's request.

The CreateVersion method's request.

A curation resource in the API Hub.

The error codes for failed executions.

The state of the last execution of the curation.

The plugin instance and associated action that is using the curation.

The curation information for this plugin instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Custom curation information for this plugin instance.

Enum for the curation type.

Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only schema object is supported.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Enumeration of definition types.

The DeleteApiHubInstance method's request.

The DeleteApiOperation method's request.

The DeleteApi method's request.

The DeleteAttribute method's request.

The DeleteCuration][ApiHub.DeleteCuration] method's request.

The DeleteDependency method's request.

The DeleteDeployment method's request.

The DeleteExternalApi method's request.

The DeletePluginInstance method's request.

The DeletePlugin][ApiHub.DeletePlugin] method's request.

The DeleteRuntimeProjectAttachment method's request.

The DeleteSpec method's request.

The DeleteVersion method's request.

A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and [External API][google.cloud.apihub.v1.ExternalApi].

The abstract base class for a message.

Possible modes of discovering the dependency.

Possible states for a dependency.

Reference to an entity participating in a dependency.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Details describing error condition of a dependency.

Possible values representing an error in the dependency.

Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.

The abstract base class for a message.

The metadata associated with a deployment.

The DisablePluginInstanceAction method's request.

The DisablePluginInstanceAction method's response.

The DisablePlugin method's request.

Respresents an API Observation observed in one of the sources.

The possible types of the source from which the observation was collected.

DiscoveredApiObservation protocol style

DiscoveredApiOperation represents an API Operation observed in one of the sources.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The classification of the discovered API operation.

MatchResult represents the result of matching a discovered API operation with a catalog API operation.

Documentation details.

The EnablePluginInstanceAction method's request.

The EnablePluginInstanceAction method's response.

The EnablePlugin method's request.

The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The ExecutePluginInstanceAction method's request.

The ExecutePluginInstanceAction method's response.

The execution status for the plugin instance.

Enum for the current state of the execution.

The result of the last execution of the plugin instance.

Enum for the result of the last execution of the plugin instance.

An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.

The abstract base class for a message.

Enum for the gateway type.

The GetApiHubInstance method's request.

The GetApiOperation method's request.

The GetApi method's request.

The GetAttribute method's request.

The GetCuration][ApiHub.GetCuration] method's request.

The GetDefinition method's request.

The GetDependency][.ApiHubDependencies.GetDependency] method's request.

The GetDeployment method's request.

Message for requesting a DiscoveredApiObservation

Message for requesting a DiscoveredApiOperation

The GetExternalApi method's request.

The GetHostProjectRegistration method's request.

The GetPluginInstance method's request.

The GetPlugin method's request.

The GetRuntimeProjectAttachment method's request.

The GetSpecContents method's request.

The GetSpec method's request.

The GetStyleGuideContents method's request.

The GetStyleGuide method's request.

The GetVersion method's request.

Config for Google service account authentication.

Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.

The HTTP Operation.

Enumeration of Method types.

An HTTP-based API Operation, sometimes called a "REST" Operation.

Type of data

An aggregation of HTTP header occurrences.

An aggregation of HTTP requests.

The abstract base class for a message.

An aggregation of HTTP responses.

The abstract base class for a message.

The abstract base class for a message.

HTTP Path parameter.

An aggregation of HTTP query parameter occurrences.

The abstract base class for a message.

Issue contains the details of a single issue found by the linter.

LintResponse contains the response from the linter.

Count of issues with a given severity.

The LintSpec method's request.

Lint state represents success or failure for linting.

Enumeration of linter types.

The ListApiOperations method's request.

The ListApiOperations method's response.

The ListApis method's request.

The ListApis method's response.

The ListAttributes method's request.

The ListAttributes method's response.

The ListCurations][ApiHub.ListCurations] method's request.

The ListCurations][ApiHub.ListCurations] method's response.

The ListDependencies method's request.

The ListDependencies method's response.

The ListDeployments method's request.

The ListDeployments method's response.

Message for requesting list of DiscoveredApiObservations

Message for response to listing DiscoveredApiObservations

Message for requesting list of DiscoveredApiOperations

Message for response to listing DiscoveredApiOperations

The ListExternalApis method's request.

The ListExternalApis method's response.

The ListHostProjectRegistrations method's request.

The ListHostProjectRegistrations method's response.

The ListPluginInstances method's request.

The ListPluginInstances method's response.

The ListPlugins method's request.

The ListPlugins method's response.

The ListRuntimeProjectAttachments method's request.

The ListRuntimeProjectAttachments method's response.

The ListSpecs][ListSpecs] method's request.

The ListSpecs method's response.

The ListVersions method's request.

The ListVersions method's response.

The LookupApiHubInstance method's request.

The LookupApiHubInstance method's response.`

The LookupRuntimeProjectAttachment method's request.

The ListRuntimeProjectAttachments method's response.

OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails.

Enumeration of spec formats.

The operation details parsed from the spec.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the metadata of the long-running operation.

Owner details.

The path details derived from the spec.

A plugin resource in the API Hub.

ConfigTemplate represents the configuration template for a plugin.

AuthConfigTemplate represents the authentication template for a plugin.

The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality.

Ownership type of the plugin.

Possible states a plugin can have. Note that this enum may receive new values in the future. Consumers are advised to always code against the enum values expecting new states can be added later on.

PluginActionConfig represents the configuration of an action supported by a plugin.

Execution mode of the action.

Enum for the plugin category.

Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.

The abstract base class for a message.

State represents the state of the plugin instance.

PluginInstanceAction represents an action which can be executed in the plugin instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The configuration of resources created for a given plugin instance action.

State represents the state of the plugin instance action.

Point within the file (line and character).

Object describing where in the file the issue was found.

Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.

The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the definitions section for OpenAPI 2.0 version and in components.schemas section for OpenAPI 3.0 and 3.1 version.

The SearchResources method's request.

Response for the SearchResources method.

Represents the search results.

Secret provides a reference to entries in Secret Manager.

Severity of the issue.

SourceMetadata represents the metadata for a resource at the source.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PluginInstanceActionSource represents the plugin instance action source.

The possible types of the source.

Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.

The abstract base class for a message.

Specifies the parsing mode for API specifications during creation and update.

• RELAXED: Parsing errors in the specification content do not fail the API call.
• STRICT: Parsing errors in the specification content result in failure of the API call. If not specified, defaults to RELAXED.

The spec contents.

SpecDetails contains the details parsed from supported spec types.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The metadata associated with a spec of the API version.

Represents a singleton style guide resource to be used for linting Open API specs.

The style guide contents.

The UpdateApiOperation method's request.

The UpdateApi method's request.

The UpdateAttribute method's request.

The UpdateCuration][ApiHub.UpdateCuration] method's request.

The UpdateDependency method's request.

The UpdateDeployment method's request.

The UpdateExternalApi method's request.

The UpdatePluginInstance method's request.

The UpdateSpec method's request.

The UpdateStyleGuide method's request.

The UpdateVersion method's request.

Represents a version of the API resource in API hub. This is also referred to as the API version.

The abstract base class for a message.

The metadata associated with a version of the API resource.

API documentation for apihub_v1.services.api_hub.pagers module.

API documentation for apihub_v1.services.api_hub_curate.pagers module.

API documentation for apihub_v1.services.api_hub_dependencies.pagers module.

API documentation for apihub_v1.services.api_hub_discovery.pagers module.

API documentation for apihub_v1.services.api_hub_plugin.pagers module.

API documentation for apihub_v1.services.host_project_registration_service.pagers module.

API documentation for apihub_v1.services.runtime_project_attachment_service.pagers module.