Package types (0.2.7)

The API metadata.

The details for the action to execute.

Enum for the action type.

An API resource in the API Hub.

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.

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 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 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

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

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

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

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 curation information for this plugin instance.

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

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 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].

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.

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 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.

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

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.

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.

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.

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

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

LintResponse contains the response from the linter.

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.

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.

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

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.

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

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

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 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 metadata associated with a version of the API resource.