Package Classes (0.2.3)

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 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 is used for managing plugins inside the API Hub.

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.

An API resource in the API Hub.

The abstract base class for a message.

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.

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

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.

The abstract base class for a message.

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.

The CreateApiHubInstance method's request.

The CreateApi method's request.

The CreateAttribute method's request.

The CreateDependency method's request.

The CreateDeployment method's request.

The CreateExternalApi method's request.

The CreateHostProjectRegistration method's request.

The CreateRuntimeProjectAttachment method's request.

The CreateSpec method's request.

The CreateVersion method's request.

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 DeleteApi method's request.

The DeleteAttribute method's request.

The DeleteDependency method's request.

The DeleteDeployment method's request.

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

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 DisablePlugin method's request.

Documentation details.

The EnablePlugin method's request.

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.

The GetApiHubInstance method's request.

The GetApiOperation method's request.

The GetApi method's request.

The GetAttribute method's request.

The GetDefinition method's request.

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

The GetDeployment method's request.

The GetExternalApi method's request.

The GetHostProjectRegistration 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][ApiHub.GetStyleGuideContents] method's request.

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

The GetVersion method's request.

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.

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][ApiHub.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 ListDependencies method's request.

The ListDependencies method's response.

The ListDeployments method's request.

The ListDeployments method's response.

The ListExternalApis method's request.

The ListExternalApis method's response.

The ListHostProjectRegistrations method's request.

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

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.

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.

Severity of the issue.

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

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

The style guide contents.

The UpdateApi method's request.

The UpdateAttribute method's request.

The UpdateDependency method's request.

The UpdateDeployment method's request.

The UpdateExternalApi method's request.

The UpdateSpec method's request.

The UpdateStyleGuide][ApiHub.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.

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

API documentation for apihub_v1.services.api_hub_dependencies.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.