API hub v1 API - Namespace Google.Cloud.ApiHub.V1 (1.0.0-beta02)

An API resource in the API Hub.

This service provides all methods related to the API hub.

Base class for server-side implementations of ApiHub

Client for ApiHub

ApiHub client wrapper, for convenient use.

Builder class for ApiHubClient to provide simple configuration of credentials, endpoint etc.

ApiHub client wrapper implementation, for convenient use.

This service provides methods for various operations related to a [Dependency][google.cloud.apihub.v1.Dependency] in the API hub.

Base class for server-side implementations of ApiHubDependencies

Client for ApiHubDependencies

ApiHubDependencies client wrapper, for convenient use.

Builder class for ApiHubDependenciesClient to provide simple configuration of credentials, endpoint etc.

ApiHubDependencies client wrapper implementation, for convenient use.

Settings for ApiHubDependenciesClient instances.

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

Container for nested types declared in the ApiHubInstance message type.

Available configurations to provision an ApiHub Instance.

Resource name for the ApiHubInstance resource.

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

Base class for server-side implementations of ApiHubPlugin

Client for ApiHubPlugin

ApiHubPlugin client wrapper, for convenient use.

Builder class for ApiHubPluginClient to provide simple configuration of credentials, endpoint etc.

ApiHubPlugin client wrapper implementation, for convenient use.

Settings for ApiHubPluginClient instances.

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

Settings for ApiHubClient instances.

Resource name for the Api resource.

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.

Resource name for the ApiOperation resource.

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.

Container for nested types declared in the Attribute message type.

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

Resource name for the Attribute resource.

The attribute values associated with resource.

Container for nested types declared in the AttributeValues message type.

The attribute values of data type enum.

The attribute values of data type string or JSON.

The [CreateApiHubInstance][google.cloud.apihub.v1.Provisioning.CreateApiHubInstance] method's request.

The [CreateApi][google.cloud.apihub.v1.ApiHub.CreateApi] method's request.

The [CreateAttribute][google.cloud.apihub.v1.ApiHub.CreateAttribute] method's request.

The [CreateDependency][google.cloud.apihub.v1.ApiHubDependencies.CreateDependency] method's request.

The [CreateDeployment][google.cloud.apihub.v1.ApiHub.CreateDeployment] method's request.

The [CreateExternalApi][google.cloud.apihub.v1.ApiHub.CreateExternalApi] method's request.

The [CreateHostProjectRegistration][google.cloud.apihub.v1.HostProjectRegistrationService.CreateHostProjectRegistration] method's request.

The [CreateRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.CreateRuntimeProjectAttachment] method's request.

The [CreateSpec][google.cloud.apihub.v1.ApiHub.CreateSpec] method's request.

The [CreateVersion][google.cloud.apihub.v1.ApiHub.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.

Container for nested types declared in the Definition message type.

Resource name for the Definition resource.

The [DeleteApi][google.cloud.apihub.v1.ApiHub.DeleteApi] method's request.

The [DeleteAttribute][google.cloud.apihub.v1.ApiHub.DeleteAttribute] method's request.

The [DeleteDependency][google.cloud.apihub.v1.ApiHubDependencies.DeleteDependency] method's request.

The [DeleteDeployment][google.cloud.apihub.v1.ApiHub.DeleteDeployment] method's request.

The [DeleteExternalApi][google.cloud.apihub.v1.ApiHub.DeleteExternalApi] method's request.

The [DeleteRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.DeleteRuntimeProjectAttachment] method's request.

The [DeleteSpec][google.cloud.apihub.v1.ApiHub.DeleteSpec] method's request.

The [DeleteVersion][google.cloud.apihub.v1.ApiHub.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][google.cloud.apihub.v1.Operation] or between an [Operation][google.cloud.apihub.v1.Operation] and [External API][google.cloud.apihub.v1.ExternalApi].

Container for nested types declared in the Dependency message type.

Reference to an entity participating in a dependency.

Details describing error condition of a dependency.

Container for nested types declared in the DependencyErrorDetail message type.

Resource name for the Dependency resource.

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.

Resource name for the Deployment resource.

The [DisablePlugin][google.cloud.apihub.v1.ApiHubPlugin.DisablePlugin] method's request.

Documentation details.

The [EnablePlugin][google.cloud.apihub.v1.ApiHubPlugin.EnablePlugin] method's request.

Resource name for the Extension resource.

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.

Resource name for the ExternalApi resource.

The [GetApiHubInstance][google.cloud.apihub.v1.Provisioning.GetApiHubInstance] method's request.

The [GetApiOperation][google.cloud.apihub.v1.ApiHub.GetApiOperation] method's request.

The [GetApi][google.cloud.apihub.v1.ApiHub.GetApi] method's request.

The [GetAttribute][google.cloud.apihub.v1.ApiHub.GetAttribute] method's request.

The [GetDefinition][google.cloud.apihub.v1.ApiHub.GetDefinition] method's request.

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

The [GetDeployment][google.cloud.apihub.v1.ApiHub.GetDeployment] method's request.

The [GetExternalApi][google.cloud.apihub.v1.ApiHub.GetExternalApi] method's request.

The [GetHostProjectRegistration][google.cloud.apihub.v1.HostProjectRegistrationService.GetHostProjectRegistration] method's request.

The [GetPlugin][google.cloud.apihub.v1.ApiHubPlugin.GetPlugin] method's request.

The [GetRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.GetRuntimeProjectAttachment] method's request.

The [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method's request.

The [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method's request.

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

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

The [GetVersion][google.cloud.apihub.v1.ApiHub.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.

Resource name for the HostProjectRegistration resource.

This service is used for managing the host project registrations.

Base class for server-side implementations of HostProjectRegistrationService

Client for HostProjectRegistrationService

HostProjectRegistrationService client wrapper, for convenient use.

Builder class for HostProjectRegistrationServiceClient to provide simple configuration of credentials, endpoint etc.

HostProjectRegistrationService client wrapper implementation, for convenient use.

Settings for HostProjectRegistrationServiceClient instances.

The HTTP Operation.

Container for nested types declared in the HttpOperation message type.

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

LintResponse contains the response from the linter.

Container for nested types declared in the LintResponse message type.

Count of issues with a given severity.

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

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

Base class for server-side implementations of LintingService

Client for LintingService

LintingService client wrapper, for convenient use.

Builder class for LintingServiceClient to provide simple configuration of credentials, endpoint etc.

LintingService client wrapper implementation, for convenient use.

Settings for LintingServiceClient instances.

The [ListApiOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method's request.

The [ListApiOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method's response.

The [ListApis][google.cloud.apihub.v1.ApiHub.ListApis] method's request.

The [ListApis][google.cloud.apihub.v1.ApiHub.ListApis] method's response.

The [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method's request.

The [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method's response.

The [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies] method's request.

The [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies] method's response.

The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's request.

The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's response.

The [ListExternalApis][google.cloud.apihub.v1.ApiHub.ListExternalApis] method's request.

The [ListExternalApis][google.cloud.apihub.v1.ApiHub.ListExternalApis] method's response.

The [ListHostProjectRegistrations][google.cloud.apihub.v1.HostProjectRegistrationService.ListHostProjectRegistrations] method's request.

The [ListHostProjectRegistrations][google.cloud.apihub.v1.HostProjectRegistrationService.ListHostProjectRegistrations] method's response.

The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's request.

The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's response.

The [ListSpecs][ListSpecs] method's request.

The [ListSpecs][google.cloud.apihub.v1.ApiHub.ListSpecs] method's response.

The [ListVersions][google.cloud.apihub.v1.ApiHub.ListVersions] method's request.

The [ListVersions][google.cloud.apihub.v1.ApiHub.ListVersions] method's response.

The [LookupApiHubInstance][google.cloud.apihub.v1.Provisioning.LookupApiHubInstance] method's request.

The [LookupApiHubInstance][google.cloud.apihub.v1.Provisioning.LookupApiHubInstance] method's response.`

The [LookupRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.LookupRuntimeProjectAttachment] method's request.

The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's response.

OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in [SpecDetails][google.cloud.apihub.v1.SpecDetails].

Container for nested types declared in the OpenApiSpecDetails message type.

The operation details parsed from the spec.

Represents the metadata of the long-running operation.

Owner details.

The path details derived from the spec.

A plugin resource in the API Hub.

Container for nested types declared in the Plugin message type.

Resource name for the Plugin resource.

Point within the file (line and character).

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

Base class for server-side implementations of Provisioning

Client for Provisioning

Provisioning client wrapper, for convenient use.

Builder class for ProvisioningClient to provide simple configuration of credentials, endpoint etc.

Provisioning client wrapper implementation, for convenient use.

Settings for ProvisioningClient instances.

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.

Resource name for the RuntimeProjectAttachment resource.

This service is used for managing the runtime project attachments.

Base class for server-side implementations of RuntimeProjectAttachmentService

Client for RuntimeProjectAttachmentService

RuntimeProjectAttachmentService client wrapper, for convenient use.

Builder class for RuntimeProjectAttachmentServiceClient to provide simple configuration of credentials, endpoint etc.

RuntimeProjectAttachmentService client wrapper implementation, for convenient use.

Settings for RuntimeProjectAttachmentServiceClient instances.

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][google.cloud.apihub.v1.ApiHub.SearchResources] method's request.

Response for the [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method.

Represents the search results.

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.

Container for nested types declared in the Spec message type.

The spec contents.

SpecDetails contains the details parsed from supported spec types.

Resource name for the Spec resource.

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

The style guide contents.

Resource name for the StyleGuide resource.

The [UpdateApi][google.cloud.apihub.v1.ApiHub.UpdateApi] method's request.

The [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method's request.

The [UpdateDependency][google.cloud.apihub.v1.ApiHubDependencies.UpdateDependency] method's request.

The [UpdateDeployment][google.cloud.apihub.v1.ApiHub.UpdateDeployment] method's request.

The [UpdateExternalApi][google.cloud.apihub.v1.ApiHub.UpdateExternalApi] method's request.

The [UpdateSpec][google.cloud.apihub.v1.ApiHub.UpdateSpec] method's request.

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

The [UpdateVersion][google.cloud.apihub.v1.ApiHub.UpdateVersion] method's request.

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

Resource name for the Version resource.

State of the ApiHub Instance.

The possible contents of ApiHubInstanceName.

Enum of possible cases for the "resource" oneof.

The possible contents of ApiName.

The possible contents of ApiOperationName.

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 possible contents of AttributeName.

Enum of possible cases for the "Value" oneof.

Enumeration of definition types.

Enum of possible cases for the "value" oneof.

The possible contents of DefinitionName.

Possible modes of discovering the dependency.

Possible states for a dependency.

Enum of possible cases for the "identifier" oneof.

Possible values representing an error in the dependency.

The possible contents of DependencyName.

The possible contents of DeploymentName.

The possible contents of ExtensionName.

The possible contents of ExternalApiName.

The possible contents of HostProjectRegistrationName.

Enumeration of Method types.

Lint state represents success or failure for linting.

Enumeration of linter types.

Enumeration of spec formats.

Enum of possible cases for the "operation" oneof.

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.

The possible contents of PluginName.

The possible contents of RuntimeProjectAttachmentName.

Severity of the issue.

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.

Enum of possible cases for the "details" oneof.

The possible contents of SpecName.

The possible contents of StyleGuideName.

The possible contents of VersionName.