Package Classes (0.2.1)

Summary of entries of Classes for google-cloud-apihub.

Classes

ApiHubClient

This service provides all methods related to the API hub.

ListApiOperationsPager

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.

ListApisPager

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.

ListAttributesPager

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.

ListDeploymentsPager

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.

ListExternalApisPager

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.

ListSpecsPager

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.

ListVersionsPager

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.

SearchResourcesPager

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.

ApiHubDependenciesClient

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

ListDependenciesPager

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.

ApiHubPluginClient

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

HostProjectRegistrationServiceClient

This service is used for managing the host project registrations.

ListHostProjectRegistrationsPager

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.

LintingServiceClient

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

ProvisioningClient

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

RuntimeProjectAttachmentServiceClient

This service is used for managing the runtime project attachments.

ListRuntimeProjectAttachmentsPager

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.

Api

An API resource in the API Hub.

AttributesEntry

The abstract base class for a message.

ApiHubInstance

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

Config

Available configurations to provision an ApiHub Instance.

LabelsEntry

The abstract base class for a message.

State

State of the ApiHub Instance.

ApiHubResource

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

ApiOperation

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.

AttributesEntry

The abstract base class for a message.

Attribute

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.

AllowedValue

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

DataType

Enumeration of attribute's data type.

DefinitionType

Enumeration of attribute definition types.

Scope

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

AttributeValues

The attribute values associated with resource.

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

EnumAttributeValues

The attribute values of data type enum.

StringAttributeValues

The attribute values of data type string or JSON.

CreateApiHubInstanceRequest

The CreateApiHubInstance method's request.

CreateApiRequest

The CreateApi method's request.

CreateAttributeRequest

The CreateAttribute method's request.

CreateDependencyRequest

The CreateDependency method's request.

CreateDeploymentRequest

The CreateDeployment method's request.

CreateExternalApiRequest

The CreateExternalApi method's request.

CreateHostProjectRegistrationRequest

The CreateHostProjectRegistration method's request.

CreateRuntimeProjectAttachmentRequest

The CreateRuntimeProjectAttachment method's request.

CreateSpecRequest

The CreateSpec method's request.

CreateVersionRequest

The CreateVersion method's request.

Definition

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

AttributesEntry

The abstract base class for a message.

Type

Enumeration of definition types.

DeleteApiRequest

The DeleteApi method's request.

DeleteAttributeRequest

The DeleteAttribute method's request.

DeleteDependencyRequest

The DeleteDependency method's request.

DeleteDeploymentRequest

The DeleteDeployment method's request.

DeleteExternalApiRequest

The DeleteExternalApi method's request.

DeleteRuntimeProjectAttachmentRequest

The DeleteRuntimeProjectAttachment method's request.

DeleteSpecRequest

The DeleteSpec method's request.

DeleteVersionRequest

The DeleteVersion method's request.

Dependency

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.

AttributesEntry

The abstract base class for a message.

DiscoveryMode

Possible modes of discovering the dependency.

State

Possible states for a dependency.

DependencyEntityReference

Reference to an entity participating in a dependency.

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

DependencyErrorDetail

Details describing error condition of a dependency.

Error

Possible values representing an error in the dependency.

Deployment

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.

AttributesEntry

The abstract base class for a message.

DisablePluginRequest

The DisablePlugin method's request.

Documentation

Documentation details.

EnablePluginRequest

The EnablePlugin method's request.

ExternalApi

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.

AttributesEntry

The abstract base class for a message.

GetApiHubInstanceRequest

The GetApiHubInstance method's request.

GetApiOperationRequest

The GetApiOperation method's request.

GetApiRequest

The GetApi method's request.

GetAttributeRequest

The GetAttribute method's request.

GetDefinitionRequest

The GetDefinition method's request.

GetDependencyRequest

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

GetDeploymentRequest

The GetDeployment method's request.

GetExternalApiRequest

The GetExternalApi method's request.

GetHostProjectRegistrationRequest

The GetHostProjectRegistration method's request.

GetPluginRequest

The GetPlugin method's request.

GetRuntimeProjectAttachmentRequest

The GetRuntimeProjectAttachment method's request.

GetSpecContentsRequest

The GetSpecContents method's request.

GetSpecRequest

The GetSpec method's request.

GetStyleGuideContentsRequest

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

GetStyleGuideRequest

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

GetVersionRequest

The GetVersion method's request.

HostProjectRegistration

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.

HttpOperation

The HTTP Operation.

Method

Enumeration of Method types.

Issue

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

LintResponse

LintResponse contains the response from the linter.

SummaryEntry

Count of issues with a given severity.

LintSpecRequest

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

LintState

Lint state represents success or failure for linting.

Linter

Enumeration of linter types.

ListApiOperationsRequest

The ListApiOperations method's request.

ListApiOperationsResponse

The ListApiOperations method's response.

ListApisRequest

The ListApis method's request.

ListApisResponse

The ListApis method's response.

ListAttributesRequest

The ListAttributes method's request.

ListAttributesResponse

The ListAttributes method's response.

ListDependenciesRequest

The ListDependencies method's request.

ListDependenciesResponse

The ListDependencies method's response.

ListDeploymentsRequest

The ListDeployments method's request.

ListDeploymentsResponse

The ListDeployments method's response.

ListExternalApisRequest

The ListExternalApis method's request.

ListExternalApisResponse

The ListExternalApis method's response.

ListHostProjectRegistrationsRequest

The ListHostProjectRegistrations method's request.

ListHostProjectRegistrationsResponse

The ListHostProjectRegistrations method's response.

ListRuntimeProjectAttachmentsRequest

The ListRuntimeProjectAttachments method's request.

ListRuntimeProjectAttachmentsResponse

The ListRuntimeProjectAttachments method's response.

ListSpecsRequest

The ListSpecs][ListSpecs] method's request.

ListSpecsResponse

The ListSpecs method's response.

ListVersionsRequest

The ListVersions method's request.

ListVersionsResponse

The ListVersions method's response.

LookupApiHubInstanceRequest

The LookupApiHubInstance method's request.

LookupApiHubInstanceResponse

The LookupApiHubInstance method's response.`

LookupRuntimeProjectAttachmentRequest

The LookupRuntimeProjectAttachment method's request.

LookupRuntimeProjectAttachmentResponse

The ListRuntimeProjectAttachments method's response.

OpenApiSpecDetails

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

Format

Enumeration of spec formats.

OperationDetails

The operation details parsed from the spec.

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

OperationMetadata

Represents the metadata of the long-running operation.

Owner

Owner details.

Path

The path details derived from the spec.

Plugin

A plugin resource in the API Hub.

State

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

Point within the file (line and character).

Range

Object describing where in the file the issue was found.

RuntimeProjectAttachment

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.

Schema

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.

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.