API documentation for apihub_v1.types package.
Classes
Api
An API resource in the API Hub.
ApiHubInstance
An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
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.
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.
AttributeValues
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
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
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.
DependencyEntityReference
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
DependencyErrorDetail
Details describing error condition of a 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.
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.
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.
Issue
Issue contains the details of a single issue found by the linter.
LintResponse
LintResponse contains the response from the linter.
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.
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.
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.
SearchResourcesRequest
The SearchResources method's request.
SearchResourcesResponse
Response for the SearchResources method.
SearchResult
Represents the search results.
Severity
Severity of the issue.
Spec
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.
SpecContents
The spec contents.
SpecDetails
SpecDetails contains the details parsed from supported spec types.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StyleGuide
Represents a singleton style guide resource to be used for linting Open API specs.
StyleGuideContents
The style guide contents.
UpdateApiRequest
The UpdateApi method's request.
UpdateAttributeRequest
The UpdateAttribute method's request.
UpdateDependencyRequest
The UpdateDependency method's request.
UpdateDeploymentRequest
The UpdateDeployment method's request.
UpdateExternalApiRequest
The UpdateExternalApi method's request.
UpdateSpecRequest
The UpdateSpec method's request.
UpdateStyleGuideRequest
The UpdateStyleGuide][ApiHub.UpdateStyleGuide] method's request.
UpdateVersionRequest
The UpdateVersion method's request.
Version
Represents a version of the API resource in API hub. This is also referred to as the API version.