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

Classes

APIMetadata

The API metadata.

ActionExecutionDetail

The details for the action to execute.

Api

An API resource in the API Hub.

ApiData

The API data to be collected.

ApiHub

This service provides all methods related to the API hub.

ApiHub.ApiHubBase

Base class for server-side implementations of ApiHub

ApiHub.ApiHubClient

Client for ApiHub

ApiHubClient

ApiHub client wrapper, for convenient use.

ApiHubClientBuilder

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

ApiHubClientImpl

ApiHub client wrapper implementation, for convenient use.

ApiHubCollect

This service exposes methods used for collecting various types of data from different first party and third party sources and push it to Hub's collect layer.

ApiHubCollect.ApiHubCollectBase

Base class for server-side implementations of ApiHubCollect

ApiHubCollect.ApiHubCollectClient

Client for ApiHubCollect

ApiHubCollectClient

ApiHubCollect client wrapper, for convenient use.

ApiHubCollectClientBuilder

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

ApiHubCollectClientImpl

ApiHubCollect client wrapper implementation, for convenient use.

ApiHubCollectSettings

Settings for ApiHubCollectClient instances.

ApiHubCurate

This service is used for managing curations for processing API data consumed from collect layer.

ApiHubCurate.ApiHubCurateBase

Base class for server-side implementations of ApiHubCurate

ApiHubCurate.ApiHubCurateClient

Client for ApiHubCurate

ApiHubCurateClient

ApiHubCurate client wrapper, for convenient use.

ApiHubCurateClientBuilder

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

ApiHubCurateClientImpl

ApiHubCurate client wrapper implementation, for convenient use.

ApiHubCurateSettings

Settings for ApiHubCurateClient instances.

ApiHubDependencies

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

ApiHubDependencies.ApiHubDependenciesBase

Base class for server-side implementations of ApiHubDependencies

ApiHubDependencies.ApiHubDependenciesClient

Client for ApiHubDependencies

ApiHubDependenciesClient

ApiHubDependencies client wrapper, for convenient use.

ApiHubDependenciesClientBuilder

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

ApiHubDependenciesClientImpl

ApiHubDependencies client wrapper implementation, for convenient use.

ApiHubDependenciesSettings

Settings for ApiHubDependenciesClient instances.

ApiHubDiscovery

This service exposes methods used to manage DiscoveredApiObservations and DiscoveredApiOperations.

ApiHubDiscovery.ApiHubDiscoveryBase

Base class for server-side implementations of ApiHubDiscovery

ApiHubDiscovery.ApiHubDiscoveryClient

Client for ApiHubDiscovery

ApiHubDiscoveryClient

ApiHubDiscovery client wrapper, for convenient use.

ApiHubDiscoveryClientBuilder

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

ApiHubDiscoveryClientImpl

ApiHubDiscovery client wrapper implementation, for convenient use.

ApiHubDiscoverySettings

Settings for ApiHubDiscoveryClient instances.

ApiHubInstance

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

ApiHubInstance.Types

Container for nested types declared in the ApiHubInstance message type.

ApiHubInstance.Types.Config

Available configurations to provision an ApiHub Instance.

ApiHubInstance.Types.Config.Types

Container for nested types declared in the Config message type.

ApiHubInstanceName

Resource name for the ApiHubInstance resource.

ApiHubPlugin

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

ApiHubPlugin.ApiHubPluginBase

Base class for server-side implementations of ApiHubPlugin

ApiHubPlugin.ApiHubPluginClient

Client for ApiHubPlugin

ApiHubPluginClient

ApiHubPlugin client wrapper, for convenient use.

ApiHubPluginClientBuilder

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

ApiHubPluginClientImpl

ApiHubPlugin client wrapper implementation, for convenient use.

ApiHubPluginSettings

Settings for ApiHubPluginClient instances.

ApiHubResource

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

ApiHubSettings

Settings for ApiHubClient instances.

ApiMetadataList

The message to hold repeated API metadata.

ApiName

Resource name for the Api resource.

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

ApiOperationName

Resource name for the ApiOperation resource.

ApplicationIntegrationEndpointDetails

The details of the Application Integration endpoint to be triggered for curation.

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.

Attribute.Types

Container for nested types declared in the Attribute message type.

Attribute.Types.AllowedValue

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

AttributeName

Resource name for the Attribute resource.

AttributeValues

The attribute values associated with resource.

AttributeValues.Types

Container for nested types declared in the AttributeValues message type.

AttributeValues.Types.EnumAttributeValues

The attribute values of data type enum.

AttributeValues.Types.StringAttributeValues

The attribute values of data type string or JSON.

AuthConfig

AuthConfig represents the authentication information.

AuthConfig.Types

Container for nested types declared in the AuthConfig message type.

AuthConfig.Types.ApiKeyConfig

Config for authentication with API key.

AuthConfig.Types.ApiKeyConfig.Types

Container for nested types declared in the ApiKeyConfig message type.

AuthConfig.Types.Oauth2ClientCredentialsConfig

Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.

AuthConfig.Types.UserPasswordConfig

Parameters to support Username and Password Authentication.

CollectApiDataRequest

The CollectApiData method's request.

CollectApiDataResponse

The CollectApiData method's response.

ConfigValueOption

ConfigValueOption represents an option for a config variable of type enum or multi select.

ConfigVariable

ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.

ConfigVariable.Types

Container for nested types declared in the ConfigVariable message type.

ConfigVariable.Types.MultiIntValues

The config variable value of data type multi int.

ConfigVariable.Types.MultiSelectValues

The config variable value of data type multi select.

ConfigVariable.Types.MultiStringValues

The config variable value of data type multi string.

ConfigVariableTemplate

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

ConfigVariableTemplate.Types

Container for nested types declared in the ConfigVariableTemplate message type.

CreateApiHubInstanceRequest

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

CreateApiOperationRequest

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

CreateApiRequest

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

CreateAttributeRequest

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

CreateCurationRequest

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

CreateDependencyRequest

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

CreateDeploymentRequest

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

CreateExternalApiRequest

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

CreateHostProjectRegistrationRequest

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

CreatePluginInstanceRequest

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

CreatePluginRequest

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

CreateRuntimeProjectAttachmentRequest

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

CreateSpecRequest

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

CreateVersionRequest

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

Curation

A curation resource in the API Hub.

Curation.Types

Container for nested types declared in the Curation message type.

Curation.Types.PluginInstanceActionID

The plugin instance and associated action that is using the curation.

CurationConfig

The curation information for this plugin instance.

CurationConfig.Types

Container for nested types declared in the CurationConfig message type.

CurationConfig.Types.CustomCuration

Custom curation information for this plugin instance.

CurationName

Resource name for the Curation resource.

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.

Definition.Types

Container for nested types declared in the Definition message type.

DefinitionName

Resource name for the Definition resource.

DeleteApiHubInstanceRequest

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

DeleteApiOperationRequest

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

DeleteApiRequest

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

DeleteAttributeRequest

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

DeleteCurationRequest

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

DeleteDependencyRequest

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

DeleteDeploymentRequest

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

DeleteExternalApiRequest

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

DeletePluginInstanceRequest

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

DeletePluginRequest

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

DeleteRuntimeProjectAttachmentRequest

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

DeleteSpecRequest

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

DeleteVersionRequest

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

Dependency.Types

Container for nested types declared in the Dependency message type.

DependencyEntityReference

Reference to an entity participating in a dependency.

DependencyErrorDetail

Details describing error condition of a dependency.

DependencyErrorDetail.Types

Container for nested types declared in the DependencyErrorDetail message type.

DependencyName

Resource name for the Dependency resource.

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.

DeploymentMetadata

The metadata associated with a deployment.

DeploymentName

Resource name for the Deployment resource.

DisablePluginInstanceActionRequest

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

DisablePluginInstanceActionResponse

The [DisablePluginInstanceAction][google.cloud.apihub.v1.ApiHubPlugin.DisablePluginInstanceAction] method's response.

DisablePluginRequest

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

DiscoveredApiObservation

Respresents an API Observation observed in one of the sources.

DiscoveredApiObservation.Types

Container for nested types declared in the DiscoveredApiObservation message type.

DiscoveredApiObservationName

Resource name for the DiscoveredApiObservation resource.

DiscoveredApiOperation

DiscoveredApiOperation represents an API Operation observed in one of the sources.

DiscoveredApiOperation.Types

Container for nested types declared in the DiscoveredApiOperation message type.

DiscoveredApiOperation.Types.MatchResult

MatchResult represents the result of matching a discovered API operation with a catalog API operation.

DiscoveredApiOperationName

Resource name for the DiscoveredApiOperation resource.

Documentation

Documentation details.

EnablePluginInstanceActionRequest

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

EnablePluginInstanceActionResponse

The [EnablePluginInstanceAction][google.cloud.apihub.v1.ApiHubPlugin.EnablePluginInstanceAction] method's response.

EnablePluginRequest

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

Endpoint

The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing [ApiMetadata][google.cloud.apihub.v1.ApiHub.ApiMetadata]. Response should contain curated data in the form of [ApiMetadata][google.cloud.apihub.v1.ApiHub.ApiMetadata].

ExecutePluginInstanceActionRequest

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

ExecutePluginInstanceActionResponse

The [ExecutePluginInstanceAction][google.cloud.apihub.v1.ApiHubPlugin.ExecutePluginInstanceAction] method's response.

ExecutionStatus

The execution status for the plugin instance.

ExecutionStatus.Types

Container for nested types declared in the ExecutionStatus message type.

ExecutionStatus.Types.LastExecution

The result of the last execution of the plugin instance.

ExecutionStatus.Types.LastExecution.Types

Container for nested types declared in the LastExecution message type.

ExtensionName

Resource name for the Extension resource.

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.

ExternalApiName

Resource name for the ExternalApi resource.

GetApiHubInstanceRequest

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

GetApiOperationRequest

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

GetApiRequest

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

GetAttributeRequest

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

GetCurationRequest

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

GetDefinitionRequest

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

GetDependencyRequest

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

GetDeploymentRequest

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

GetDiscoveredApiObservationRequest

Message for requesting a DiscoveredApiObservation

GetDiscoveredApiOperationRequest

Message for requesting a DiscoveredApiOperation

GetExternalApiRequest

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

GetHostProjectRegistrationRequest

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

GetPluginInstanceRequest

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

GetPluginRequest

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

GetRuntimeProjectAttachmentRequest

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

GetSpecContentsRequest

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

GetSpecRequest

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

GetStyleGuideContentsRequest

The [GetStyleGuideContents][google.cloud.apihub.v1.LintingService.GetStyleGuideContents] method's request.

GetStyleGuideRequest

The [GetStyleGuide][google.cloud.apihub.v1.LintingService.GetStyleGuide] method's request.

GetVersionRequest

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

GoogleServiceAccountConfig

Config for Google service account authentication.

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.

HostProjectRegistrationName

Resource name for the HostProjectRegistration resource.

HostProjectRegistrationService

This service is used for managing the host project registrations.

HostProjectRegistrationService.HostProjectRegistrationServiceBase

Base class for server-side implementations of HostProjectRegistrationService

HostProjectRegistrationService.HostProjectRegistrationServiceClient

Client for HostProjectRegistrationService

HostProjectRegistrationServiceClient

HostProjectRegistrationService client wrapper, for convenient use.

HostProjectRegistrationServiceClientBuilder

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

HostProjectRegistrationServiceClientImpl

HostProjectRegistrationService client wrapper implementation, for convenient use.

HostProjectRegistrationServiceSettings

Settings for HostProjectRegistrationServiceClient instances.

HttpOperation

The HTTP Operation.

HttpOperation.Types

Container for nested types declared in the HttpOperation message type.

HttpOperationDetails

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

HttpOperationDetails.Types

Container for nested types declared in the HttpOperationDetails message type.

HttpOperationDetails.Types.Header

An aggregation of HTTP header occurrences.

HttpOperationDetails.Types.HttpRequest

An aggregation of HTTP requests.

HttpOperationDetails.Types.HttpResponse

An aggregation of HTTP responses.

HttpOperationDetails.Types.PathParam

HTTP Path parameter.

HttpOperationDetails.Types.QueryParam

An aggregation of HTTP query parameter occurrences.

Issue

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

LintResponse

LintResponse contains the response from the linter.

LintResponse.Types

Container for nested types declared in the LintResponse message type.

LintResponse.Types.SummaryEntry

Count of issues with a given severity.

LintSpecRequest

The [LintSpec][google.cloud.apihub.v1.LintingService.LintSpec] method's request.

LintingService

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

LintingService.LintingServiceBase

Base class for server-side implementations of LintingService

LintingService.LintingServiceClient

Client for LintingService

LintingServiceClient

LintingService client wrapper, for convenient use.

LintingServiceClientBuilder

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

LintingServiceClientImpl

LintingService client wrapper implementation, for convenient use.

LintingServiceSettings

Settings for LintingServiceClient instances.

ListApiOperationsRequest

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

ListApiOperationsResponse

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

ListApisRequest

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

ListApisResponse

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

ListAttributesRequest

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

ListAttributesResponse

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

ListCurationsRequest

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

ListCurationsResponse

The [ListCurations][ApiHub.ListCurations] method's response.

ListDependenciesRequest

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

ListDependenciesResponse

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

ListDeploymentsRequest

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

ListDeploymentsResponse

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

ListDiscoveredApiObservationsRequest

Message for requesting list of DiscoveredApiObservations

ListDiscoveredApiObservationsResponse

Message for response to listing DiscoveredApiObservations

ListDiscoveredApiOperationsRequest

Message for requesting list of DiscoveredApiOperations

ListDiscoveredApiOperationsResponse

Message for response to listing DiscoveredApiOperations

ListExternalApisRequest

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

ListExternalApisResponse

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

ListHostProjectRegistrationsRequest

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

ListHostProjectRegistrationsResponse

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

ListPluginInstancesRequest

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

ListPluginInstancesResponse

The [ListPluginInstances][google.cloud.apihub.v1.ApiHubPlugin.ListPluginInstances] method's response.

ListPluginsRequest

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

ListPluginsResponse

The [ListPlugins][google.cloud.apihub.v1.ApiHubPlugin.ListPlugins] method's response.

ListRuntimeProjectAttachmentsRequest

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

ListRuntimeProjectAttachmentsResponse

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

ListSpecsRequest

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

ListSpecsResponse

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

ListVersionsRequest

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

ListVersionsResponse

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

LookupApiHubInstanceRequest

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

LookupApiHubInstanceResponse

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

LookupRuntimeProjectAttachmentRequest

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

LookupRuntimeProjectAttachmentResponse

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

OpenApiSpecDetails

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

OpenApiSpecDetails.Types

Container for nested types declared in the OpenApiSpecDetails message type.

OperationDetails

The operation details parsed from the spec.

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.

Plugin.Types

Container for nested types declared in the Plugin message type.

Plugin.Types.ConfigTemplate

ConfigTemplate represents the configuration template for a plugin.

Plugin.Types.ConfigTemplate.Types

Container for nested types declared in the ConfigTemplate message type.

Plugin.Types.ConfigTemplate.Types.AuthConfigTemplate

AuthConfigTemplate represents the authentication template for a plugin.

Plugin.Types.HostingService

The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality.

PluginActionConfig

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

PluginActionConfig.Types

Container for nested types declared in the PluginActionConfig message type.

PluginInstance

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.

PluginInstance.Types

Container for nested types declared in the PluginInstance message type.

PluginInstanceAction

PluginInstanceAction represents an action which can be executed in the plugin instance.

PluginInstanceAction.Types

Container for nested types declared in the PluginInstanceAction message type.

PluginInstanceAction.Types.ResourceConfig

The configuration of resources created for a given plugin instance action.

PluginInstanceName

Resource name for the PluginInstance resource.

PluginName

Resource name for the Plugin resource.

Point

Point within the file (line and character).

Provisioning

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

Provisioning.ProvisioningBase

Base class for server-side implementations of Provisioning

Provisioning.ProvisioningClient

Client for Provisioning

ProvisioningClient

Provisioning client wrapper, for convenient use.

ProvisioningClientBuilder

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

ProvisioningClientImpl

Provisioning client wrapper implementation, for convenient use.

ProvisioningSettings

Settings for ProvisioningClient instances.

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.

RuntimeProjectAttachmentName

Resource name for the RuntimeProjectAttachment resource.

RuntimeProjectAttachmentService

This service is used for managing the runtime project attachments.

RuntimeProjectAttachmentService.RuntimeProjectAttachmentServiceBase

Base class for server-side implementations of RuntimeProjectAttachmentService

RuntimeProjectAttachmentService.RuntimeProjectAttachmentServiceClient

Client for RuntimeProjectAttachmentService

RuntimeProjectAttachmentServiceClient

RuntimeProjectAttachmentService client wrapper, for convenient use.

RuntimeProjectAttachmentServiceClientBuilder

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

RuntimeProjectAttachmentServiceClientImpl

RuntimeProjectAttachmentService client wrapper implementation, for convenient use.

RuntimeProjectAttachmentServiceSettings

Settings for RuntimeProjectAttachmentServiceClient instances.

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

SearchResourcesResponse

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

SearchResult

Represents the search results.

Secret

Secret provides a reference to entries in Secret Manager.

ServiceAccountName

Resource name for the ServiceAccount resource.

SourceMetadata

SourceMetadata represents the metadata for a resource at the source.

SourceMetadata.Types

Container for nested types declared in the SourceMetadata message type.

SourceMetadata.Types.PluginInstanceActionSource

PluginInstanceActionSource represents the plugin instance action source.

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.

Spec.Types

Container for nested types declared in the Spec message type.

SpecContents

The spec contents.

SpecDetails

SpecDetails contains the details parsed from supported spec types.

SpecMetadata

The metadata associated with a spec of the API version.

SpecName

Resource name for the Spec resource.

StyleGuide

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

StyleGuideContents

The style guide contents.

StyleGuideName

Resource name for the StyleGuide resource.

UpdateApiOperationRequest

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

UpdateApiRequest

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

UpdateAttributeRequest

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

UpdateCurationRequest

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

UpdateDependencyRequest

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

UpdateDeploymentRequest

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

UpdateExternalApiRequest

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

UpdatePluginInstanceRequest

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

UpdateSpecRequest

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

UpdateStyleGuideRequest

The [UpdateStyleGuide][google.cloud.apihub.v1.LintingService.UpdateStyleGuide] method's request.

UpdateVersionRequest

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

Version

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

VersionMetadata

The metadata associated with a version of the API resource.

VersionName

Resource name for the Version resource.

Enums

ActionType

Enum for the action type.

ApiData.DataOneofCase

Enum of possible cases for the "Data" oneof.

ApiHubInstance.Types.Config.Types.EncryptionType

Types of data encryption.

ApiHubInstance.Types.State

State of the ApiHub Instance.

ApiHubInstanceName.ResourceNameType

The possible contents of ApiHubInstanceName.

ApiHubResource.ResourceOneofCase

Enum of possible cases for the "resource" oneof.

ApiName.ResourceNameType

The possible contents of ApiName.

ApiOperationName.ResourceNameType

The possible contents of ApiOperationName.

Attribute.Types.DataType

Enumeration of attribute's data type.

Attribute.Types.DefinitionType

Enumeration of attribute definition types.

Attribute.Types.Scope

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

AttributeName.ResourceNameType

The possible contents of AttributeName.

AttributeValues.ValueOneofCase

Enum of possible cases for the "Value" oneof.

AuthConfig.ConfigOneofCase

Enum of possible cases for the "config" oneof.

AuthConfig.Types.ApiKeyConfig.Types.HttpElementLocation

Enum of location an HTTP element can be.

AuthType

AuthType represents the authentication type.

CollectionType

The type of the collect request.

ConfigVariable.ValueOneofCase

Enum of possible cases for the "value" oneof.

ConfigVariableTemplate.Types.ValueType

ValueType indicates the data type of the value.

Curation.Types.ErrorCode

The error codes for failed executions.

Curation.Types.LastExecutionState

The state of the last execution of the curation.

CurationConfig.CurationConfigOneofCase

Enum of possible cases for the "curation_config" oneof.

CurationName.ResourceNameType

The possible contents of CurationName.

CurationType

Enum for the curation type.

Definition.Types.Type

Enumeration of definition types.

Definition.ValueOneofCase

Enum of possible cases for the "value" oneof.

DefinitionName.ResourceNameType

The possible contents of DefinitionName.

Dependency.Types.DiscoveryMode

Possible modes of discovering the dependency.

Dependency.Types.State

Possible states for a dependency.

DependencyEntityReference.IdentifierOneofCase

Enum of possible cases for the "identifier" oneof.

DependencyErrorDetail.Types.Error

Possible values representing an error in the dependency.

DependencyName.ResourceNameType

The possible contents of DependencyName.

DeploymentName.ResourceNameType

The possible contents of DeploymentName.

DiscoveredApiObservation.Types.SourceType

The possible types of the source from which the observation was collected.

DiscoveredApiObservation.Types.Style

DiscoveredApiObservation protocol style

DiscoveredApiObservationName.ResourceNameType

The possible contents of DiscoveredApiObservationName.

DiscoveredApiOperation.OperationOneofCase

Enum of possible cases for the "operation" oneof.

DiscoveredApiOperation.Types.Classification

The classification of the discovered API operation.

DiscoveredApiOperationName.ResourceNameType

The possible contents of DiscoveredApiOperationName.

Endpoint.EndpointDetailsOneofCase

Enum of possible cases for the "endpoint_details" oneof.

ExecutionStatus.Types.CurrentExecutionState

Enum for the current state of the execution.

ExecutionStatus.Types.LastExecution.Types.Result

Enum for the result of the last execution of the plugin instance.

ExtensionName.ResourceNameType

The possible contents of ExtensionName.

ExternalApiName.ResourceNameType

The possible contents of ExternalApiName.

GatewayType

Enum for the gateway type.

HostProjectRegistrationName.ResourceNameType

The possible contents of HostProjectRegistrationName.

HttpOperation.Types.Method

Enumeration of Method types.

HttpOperationDetails.Types.DataType

Type of data

LintState

Lint state represents success or failure for linting.

Linter

Enumeration of linter types.

OpenApiSpecDetails.Types.Format

Enumeration of spec formats.

OperationDetails.OperationOneofCase

Enum of possible cases for the "operation" oneof.

Plugin.Types.OwnershipType

Ownership type of the plugin.

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

PluginActionConfig.Types.TriggerMode

Execution mode of the action.

PluginCategory

Enum for the plugin category.

PluginInstance.Types.State

State represents the state of the plugin instance.

PluginInstanceAction.ActionStatusOneofCase

Enum of possible cases for the "action_status" oneof.

PluginInstanceAction.Types.State

State represents the state of the plugin instance action.

PluginInstanceName.ResourceNameType

The possible contents of PluginInstanceName.

PluginName.ResourceNameType

The possible contents of PluginName.

RuntimeProjectAttachmentName.ResourceNameType

The possible contents of RuntimeProjectAttachmentName.

ServiceAccountName.ResourceNameType

The possible contents of ServiceAccountName.

Severity

Severity of the issue.

SourceMetadata.SourceOneofCase

Enum of possible cases for the "source" oneof.

SourceMetadata.Types.SourceType

The possible types of the source.

Spec.Types.ParsingMode

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.

SpecDetails.DetailsOneofCase

Enum of possible cases for the "details" oneof.

SpecName.ResourceNameType

The possible contents of SpecName.

StyleGuideName.ResourceNameType

The possible contents of StyleGuideName.

VersionName.ResourceNameType

The possible contents of VersionName.