API hub v1 API - Class ApiHubClientImpl (1.0.0) 

public sealed class ApiHubClientImpl : ApiHubClient

Reference documentation and code samples for the API hub v1 API class ApiHubClientImpl.

ApiHub client wrapper implementation, for convenient use.

Inheritance

object > ApiHubClient > ApiHubClientImpl

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Remarks

This service provides all methods related to the API hub.

Constructors

ApiHubClientImpl(ApiHubClient, ApiHubSettings, ILogger)

public ApiHubClientImpl(ApiHub.ApiHubClient grpcClient, ApiHubSettings settings, ILogger logger)

Constructs a client wrapper for the ApiHub service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ApiHubApiHubClient

The underlying gRPC client.
settings ApiHubSettings

The base ApiHubSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override ApiHub.ApiHubClient GrpcClient { get; }

The underlying gRPC ApiHub client

Property Value
Type Description
ApiHubApiHubClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CreateApi(CreateApiRequest, CallSettings)

public override Api CreateApi(CreateApiRequest request, CallSettings callSettings = null)

Create an API resource in the API hub. Once an API resource is created, versions can be added to it.

Parameters
Name Description
request CreateApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Api

The RPC response.
Overrides

CreateApiAsync(CreateApiRequest, CallSettings)

public override Task<Api> CreateApiAsync(CreateApiRequest request, CallSettings callSettings = null)

Create an API resource in the API hub. Once an API resource is created, versions can be added to it.

Parameters
Name Description
request CreateApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskApi

A Task containing the RPC response.
Overrides

CreateAttribute(CreateAttributeRequest, CallSettings)

public override Attribute CreateAttribute(CreateAttributeRequest request, CallSettings callSettings = null)

Create a user defined attribute.

Certain pre defined attributes are already created by the API hub. These attributes will have type as SYSTEM_DEFINED and can be listed via [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method. Allowed values for the same can be updated via [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.

Parameters
Name Description
request CreateAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Attribute

The RPC response.
Overrides

CreateAttributeAsync(CreateAttributeRequest, CallSettings)

public override Task<Attribute> CreateAttributeAsync(CreateAttributeRequest request, CallSettings callSettings = null)

Create a user defined attribute.

Certain pre defined attributes are already created by the API hub. These attributes will have type as SYSTEM_DEFINED and can be listed via [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method. Allowed values for the same can be updated via [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.

Parameters
Name Description
request CreateAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAttribute

A Task containing the RPC response.
Overrides

CreateDeployment(CreateDeploymentRequest, CallSettings)

public override Deployment CreateDeployment(CreateDeploymentRequest request, CallSettings callSettings = null)

Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.

Parameters
Name Description
request CreateDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Deployment

The RPC response.
Overrides

CreateDeploymentAsync(CreateDeploymentRequest, CallSettings)

public override Task<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, CallSettings callSettings = null)

Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.

Parameters
Name Description
request CreateDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDeployment

A Task containing the RPC response.
Overrides

CreateExternalApi(CreateExternalApiRequest, CallSettings)

public override ExternalApi CreateExternalApi(CreateExternalApiRequest request, CallSettings callSettings = null)

Create an External API resource in the API hub.

Parameters
Name Description
request CreateExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ExternalApi

The RPC response.
Overrides

CreateExternalApiAsync(CreateExternalApiRequest, CallSettings)

public override Task<ExternalApi> CreateExternalApiAsync(CreateExternalApiRequest request, CallSettings callSettings = null)

Create an External API resource in the API hub.

Parameters
Name Description
request CreateExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExternalApi

A Task containing the RPC response.
Overrides

CreateSpec(CreateSpecRequest, CallSettings)

public override Spec CreateSpec(CreateSpecRequest request, CallSettings callSettings = null)

Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of contents or source_uri must be provided. If contents is provided, then spec_type must also be provided.

On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the projects/{project}/locations/{location}/attributes/system-spec-type attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.

In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.

Parameters
Name Description
request CreateSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Spec

The RPC response.
Overrides

CreateSpecAsync(CreateSpecRequest, CallSettings)

public override Task<Spec> CreateSpecAsync(CreateSpecRequest request, CallSettings callSettings = null)

Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of contents or source_uri must be provided. If contents is provided, then spec_type must also be provided.

On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the projects/{project}/locations/{location}/attributes/system-spec-type attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.

In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.

Parameters
Name Description
request CreateSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSpec

A Task containing the RPC response.
Overrides

CreateVersion(CreateVersionRequest, CallSettings)

public override Version CreateVersion(CreateVersionRequest request, CallSettings callSettings = null)

Create an API version for an API resource in the API hub.

Parameters
Name Description
request CreateVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Version

The RPC response.
Overrides

CreateVersionAsync(CreateVersionRequest, CallSettings)

public override Task<Version> CreateVersionAsync(CreateVersionRequest request, CallSettings callSettings = null)

Create an API version for an API resource in the API hub.

Parameters
Name Description
request CreateVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskVersion

A Task containing the RPC response.
Overrides

DeleteApi(DeleteApiRequest, CallSettings)

public override void DeleteApi(DeleteApiRequest request, CallSettings callSettings = null)

Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.

Parameters
Name Description
request DeleteApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteApiAsync(DeleteApiRequest, CallSettings)

public override Task DeleteApiAsync(DeleteApiRequest request, CallSettings callSettings = null)

Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.

Parameters
Name Description
request DeleteApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteAttribute(DeleteAttributeRequest, CallSettings)

public override void DeleteAttribute(DeleteAttributeRequest request, CallSettings callSettings = null)

Delete an attribute.

Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.

Parameters
Name Description
request DeleteAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteAttributeAsync(DeleteAttributeRequest, CallSettings)

public override Task DeleteAttributeAsync(DeleteAttributeRequest request, CallSettings callSettings = null)

Delete an attribute.

Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.

Parameters
Name Description
request DeleteAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteDeployment(DeleteDeploymentRequest, CallSettings)

public override void DeleteDeployment(DeleteDeploymentRequest request, CallSettings callSettings = null)

Delete a deployment resource in the API hub.

Parameters
Name Description
request DeleteDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteDeploymentAsync(DeleteDeploymentRequest, CallSettings)

public override Task DeleteDeploymentAsync(DeleteDeploymentRequest request, CallSettings callSettings = null)

Delete a deployment resource in the API hub.

Parameters
Name Description
request DeleteDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteExternalApi(DeleteExternalApiRequest, CallSettings)

public override void DeleteExternalApi(DeleteExternalApiRequest request, CallSettings callSettings = null)

Delete an External API resource in the API hub.

Parameters
Name Description
request DeleteExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteExternalApiAsync(DeleteExternalApiRequest, CallSettings)

public override Task DeleteExternalApiAsync(DeleteExternalApiRequest request, CallSettings callSettings = null)

Delete an External API resource in the API hub.

Parameters
Name Description
request DeleteExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteSpec(DeleteSpecRequest, CallSettings)

public override void DeleteSpec(DeleteSpecRequest request, CallSettings callSettings = null)

Delete a spec. Deleting a spec will also delete the associated operations from the version.

Parameters
Name Description
request DeleteSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteSpecAsync(DeleteSpecRequest, CallSettings)

public override Task DeleteSpecAsync(DeleteSpecRequest request, CallSettings callSettings = null)

Delete a spec. Deleting a spec will also delete the associated operations from the version.

Parameters
Name Description
request DeleteSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteVersion(DeleteVersionRequest, CallSettings)

public override void DeleteVersion(DeleteVersionRequest request, CallSettings callSettings = null)

Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.

Parameters
Name Description
request DeleteVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteVersionAsync(DeleteVersionRequest, CallSettings)

public override Task DeleteVersionAsync(DeleteVersionRequest request, CallSettings callSettings = null)

Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.

Parameters
Name Description
request DeleteVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetApi(GetApiRequest, CallSettings)

public override Api GetApi(GetApiRequest request, CallSettings callSettings = null)

Get API resource details including the API versions contained in it.

Parameters
Name Description
request GetApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Api

The RPC response.
Overrides

GetApiAsync(GetApiRequest, CallSettings)

public override Task<Api> GetApiAsync(GetApiRequest request, CallSettings callSettings = null)

Get API resource details including the API versions contained in it.

Parameters
Name Description
request GetApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskApi

A Task containing the RPC response.
Overrides

GetApiOperation(GetApiOperationRequest, CallSettings)

public override ApiOperation GetApiOperation(GetApiOperationRequest request, CallSettings callSettings = null)

Get details about a particular operation in API version.

Parameters
Name Description
request GetApiOperationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ApiOperation

The RPC response.
Overrides

GetApiOperationAsync(GetApiOperationRequest, CallSettings)

public override Task<ApiOperation> GetApiOperationAsync(GetApiOperationRequest request, CallSettings callSettings = null)

Get details about a particular operation in API version.

Parameters
Name Description
request GetApiOperationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskApiOperation

A Task containing the RPC response.
Overrides

GetAttribute(GetAttributeRequest, CallSettings)

public override Attribute GetAttribute(GetAttributeRequest request, CallSettings callSettings = null)

Get details about the attribute.

Parameters
Name Description
request GetAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Attribute

The RPC response.
Overrides

GetAttributeAsync(GetAttributeRequest, CallSettings)

public override Task<Attribute> GetAttributeAsync(GetAttributeRequest request, CallSettings callSettings = null)

Get details about the attribute.

Parameters
Name Description
request GetAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAttribute

A Task containing the RPC response.
Overrides

GetDefinition(GetDefinitionRequest, CallSettings)

public override Definition GetDefinition(GetDefinitionRequest request, CallSettings callSettings = null)

Get details about a definition in an API version.

Parameters
Name Description
request GetDefinitionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Definition

The RPC response.
Overrides

GetDefinitionAsync(GetDefinitionRequest, CallSettings)

public override Task<Definition> GetDefinitionAsync(GetDefinitionRequest request, CallSettings callSettings = null)

Get details about a definition in an API version.

Parameters
Name Description
request GetDefinitionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDefinition

A Task containing the RPC response.
Overrides

GetDeployment(GetDeploymentRequest, CallSettings)

public override Deployment GetDeployment(GetDeploymentRequest request, CallSettings callSettings = null)

Get details about a deployment and the API versions linked to it.

Parameters
Name Description
request GetDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Deployment

The RPC response.
Overrides

GetDeploymentAsync(GetDeploymentRequest, CallSettings)

public override Task<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CallSettings callSettings = null)

Get details about a deployment and the API versions linked to it.

Parameters
Name Description
request GetDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDeployment

A Task containing the RPC response.
Overrides

GetExternalApi(GetExternalApiRequest, CallSettings)

public override ExternalApi GetExternalApi(GetExternalApiRequest request, CallSettings callSettings = null)

Get details about an External API resource in the API hub.

Parameters
Name Description
request GetExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ExternalApi

The RPC response.
Overrides

GetExternalApiAsync(GetExternalApiRequest, CallSettings)

public override Task<ExternalApi> GetExternalApiAsync(GetExternalApiRequest request, CallSettings callSettings = null)

Get details about an External API resource in the API hub.

Parameters
Name Description
request GetExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExternalApi

A Task containing the RPC response.
Overrides

GetSpec(GetSpecRequest, CallSettings)

public override Spec GetSpec(GetSpecRequest request, CallSettings callSettings = null)

Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.

Parameters
Name Description
request GetSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Spec

The RPC response.
Overrides

GetSpecAsync(GetSpecRequest, CallSettings)

public override Task<Spec> GetSpecAsync(GetSpecRequest request, CallSettings callSettings = null)

Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.

Parameters
Name Description
request GetSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSpec

A Task containing the RPC response.
Overrides

GetSpecContents(GetSpecContentsRequest, CallSettings)

public override SpecContents GetSpecContents(GetSpecContentsRequest request, CallSettings callSettings = null)

Get spec contents.

Parameters
Name Description
request GetSpecContentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SpecContents

The RPC response.
Overrides

GetSpecContentsAsync(GetSpecContentsRequest, CallSettings)

public override Task<SpecContents> GetSpecContentsAsync(GetSpecContentsRequest request, CallSettings callSettings = null)

Get spec contents.

Parameters
Name Description
request GetSpecContentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSpecContents

A Task containing the RPC response.
Overrides

GetVersion(GetVersionRequest, CallSettings)

public override Version GetVersion(GetVersionRequest request, CallSettings callSettings = null)

Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.

Parameters
Name Description
request GetVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Version

The RPC response.
Overrides

GetVersionAsync(GetVersionRequest, CallSettings)

public override Task<Version> GetVersionAsync(GetVersionRequest request, CallSettings callSettings = null)

Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.

Parameters
Name Description
request GetVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskVersion

A Task containing the RPC response.
Overrides

ListApiOperations(ListApiOperationsRequest, CallSettings)

public override PagedEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperations(ListApiOperationsRequest request, CallSettings callSettings = null)

List operations in an API version.

Parameters
Name Description
request ListApiOperationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListApiOperationsResponseApiOperation

A pageable sequence of ApiOperation resources.
Overrides

ListApiOperationsAsync(ListApiOperationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperationsAsync(ListApiOperationsRequest request, CallSettings callSettings = null)

List operations in an API version.

Parameters
Name Description
request ListApiOperationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListApiOperationsResponseApiOperation

A pageable asynchronous sequence of ApiOperation resources.
Overrides

ListApis(ListApisRequest, CallSettings)

public override PagedEnumerable<ListApisResponse, Api> ListApis(ListApisRequest request, CallSettings callSettings = null)

List API resources in the API hub.

Parameters
Name Description
request ListApisRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListApisResponseApi

A pageable sequence of Api resources.
Overrides

ListApisAsync(ListApisRequest, CallSettings)

public override PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(ListApisRequest request, CallSettings callSettings = null)

List API resources in the API hub.

Parameters
Name Description
request ListApisRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListApisResponseApi

A pageable asynchronous sequence of Api resources.
Overrides

ListAttributes(ListAttributesRequest, CallSettings)

public override PagedEnumerable<ListAttributesResponse, Attribute> ListAttributes(ListAttributesRequest request, CallSettings callSettings = null)

List all attributes.

Parameters
Name Description
request ListAttributesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAttributesResponseAttribute

A pageable sequence of Attribute resources.
Overrides

ListAttributesAsync(ListAttributesRequest, CallSettings)

public override PagedAsyncEnumerable<ListAttributesResponse, Attribute> ListAttributesAsync(ListAttributesRequest request, CallSettings callSettings = null)

List all attributes.

Parameters
Name Description
request ListAttributesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAttributesResponseAttribute

A pageable asynchronous sequence of Attribute resources.
Overrides

ListDeployments(ListDeploymentsRequest, CallSettings)

public override PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(ListDeploymentsRequest request, CallSettings callSettings = null)

List deployment resources in the API hub.

Parameters
Name Description
request ListDeploymentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDeploymentsResponseDeployment

A pageable sequence of Deployment resources.
Overrides

ListDeploymentsAsync(ListDeploymentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(ListDeploymentsRequest request, CallSettings callSettings = null)

List deployment resources in the API hub.

Parameters
Name Description
request ListDeploymentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDeploymentsResponseDeployment

A pageable asynchronous sequence of Deployment resources.
Overrides

ListExternalApis(ListExternalApisRequest, CallSettings)

public override PagedEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApis(ListExternalApisRequest request, CallSettings callSettings = null)

List External API resources in the API hub.

Parameters
Name Description
request ListExternalApisRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListExternalApisResponseExternalApi

A pageable sequence of ExternalApi resources.
Overrides

ListExternalApisAsync(ListExternalApisRequest, CallSettings)

public override PagedAsyncEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApisAsync(ListExternalApisRequest request, CallSettings callSettings = null)

List External API resources in the API hub.

Parameters
Name Description
request ListExternalApisRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListExternalApisResponseExternalApi

A pageable asynchronous sequence of ExternalApi resources.
Overrides

ListSpecs(ListSpecsRequest, CallSettings)

public override PagedEnumerable<ListSpecsResponse, Spec> ListSpecs(ListSpecsRequest request, CallSettings callSettings = null)

List specs corresponding to a particular API resource.

Parameters
Name Description
request ListSpecsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSpecsResponseSpec

A pageable sequence of Spec resources.
Overrides

ListSpecsAsync(ListSpecsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSpecsResponse, Spec> ListSpecsAsync(ListSpecsRequest request, CallSettings callSettings = null)

List specs corresponding to a particular API resource.

Parameters
Name Description
request ListSpecsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSpecsResponseSpec

A pageable asynchronous sequence of Spec resources.
Overrides

ListVersions(ListVersionsRequest, CallSettings)

public override PagedEnumerable<ListVersionsResponse, Version> ListVersions(ListVersionsRequest request, CallSettings callSettings = null)

List API versions of an API resource in the API hub.

Parameters
Name Description
request ListVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListVersionsResponseVersion

A pageable sequence of Version resources.
Overrides

ListVersionsAsync(ListVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(ListVersionsRequest request, CallSettings callSettings = null)

List API versions of an API resource in the API hub.

Parameters
Name Description
request ListVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListVersionsResponseVersion

A pageable asynchronous sequence of Version resources.
Overrides

SearchResources(SearchResourcesRequest, CallSettings)

public override PagedEnumerable<SearchResourcesResponse, SearchResult> SearchResources(SearchResourcesRequest request, CallSettings callSettings = null)

Search across API-Hub resources.

Parameters
Name Description
request SearchResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchResourcesResponseSearchResult

A pageable sequence of SearchResult resources.
Overrides

SearchResourcesAsync(SearchResourcesRequest, CallSettings)

public override PagedAsyncEnumerable<SearchResourcesResponse, SearchResult> SearchResourcesAsync(SearchResourcesRequest request, CallSettings callSettings = null)

Search across API-Hub resources.

Parameters
Name Description
request SearchResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchResourcesResponseSearchResult

A pageable asynchronous sequence of SearchResult resources.
Overrides

UpdateApi(UpdateApiRequest, CallSettings)

public override Api UpdateApi(UpdateApiRequest request, CallSettings callSettings = null)

Update an API resource in the API hub. The following fields in the [API][] can be updated:

  • [display_name][google.cloud.apihub.v1.Api.display_name]
  • [description][google.cloud.apihub.v1.Api.description]
  • [owner][google.cloud.apihub.v1.Api.owner]
  • [documentation][google.cloud.apihub.v1.Api.documentation]
  • [target_user][google.cloud.apihub.v1.Api.target_user]
  • [team][google.cloud.apihub.v1.Api.team]
  • [business_unit][google.cloud.apihub.v1.Api.business_unit]
  • [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
  • [attributes][google.cloud.apihub.v1.Api.attributes]

The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.

Updating the owner field requires complete owner message and updates both owner and email fields.

Parameters
Name Description
request UpdateApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Api

The RPC response.
Overrides

UpdateApiAsync(UpdateApiRequest, CallSettings)

public override Task<Api> UpdateApiAsync(UpdateApiRequest request, CallSettings callSettings = null)

Update an API resource in the API hub. The following fields in the [API][] can be updated:

  • [display_name][google.cloud.apihub.v1.Api.display_name]
  • [description][google.cloud.apihub.v1.Api.description]
  • [owner][google.cloud.apihub.v1.Api.owner]
  • [documentation][google.cloud.apihub.v1.Api.documentation]
  • [target_user][google.cloud.apihub.v1.Api.target_user]
  • [team][google.cloud.apihub.v1.Api.team]
  • [business_unit][google.cloud.apihub.v1.Api.business_unit]
  • [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
  • [attributes][google.cloud.apihub.v1.Api.attributes]

The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.

Updating the owner field requires complete owner message and updates both owner and email fields.

Parameters
Name Description
request UpdateApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskApi

A Task containing the RPC response.
Overrides

UpdateAttribute(UpdateAttributeRequest, CallSettings)

public override Attribute UpdateAttribute(UpdateAttributeRequest request, CallSettings callSettings = null)

Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:

  • [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only.
  • [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only.
  • [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted.
  • [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update.

The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Attribute

The RPC response.
Overrides

UpdateAttributeAsync(UpdateAttributeRequest, CallSettings)

public override Task<Attribute> UpdateAttributeAsync(UpdateAttributeRequest request, CallSettings callSettings = null)

Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:

  • [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only.
  • [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only.
  • [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted.
  • [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update.

The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateAttributeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAttribute

A Task containing the RPC response.
Overrides

UpdateDeployment(UpdateDeploymentRequest, CallSettings)

public override Deployment UpdateDeployment(UpdateDeploymentRequest request, CallSettings callSettings = null)

Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated:

  • [display_name][google.cloud.apihub.v1.Deployment.display_name]
  • [description][google.cloud.apihub.v1.Deployment.description]
  • [documentation][google.cloud.apihub.v1.Deployment.documentation]
  • [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
  • [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
  • [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
  • [slo][google.cloud.apihub.v1.Deployment.slo]
  • [environment][google.cloud.apihub.v1.Deployment.environment]
  • [attributes][google.cloud.apihub.v1.Deployment.attributes]

The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Deployment

The RPC response.
Overrides

UpdateDeploymentAsync(UpdateDeploymentRequest, CallSettings)

public override Task<Deployment> UpdateDeploymentAsync(UpdateDeploymentRequest request, CallSettings callSettings = null)

Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated:

  • [display_name][google.cloud.apihub.v1.Deployment.display_name]
  • [description][google.cloud.apihub.v1.Deployment.description]
  • [documentation][google.cloud.apihub.v1.Deployment.documentation]
  • [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
  • [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
  • [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
  • [slo][google.cloud.apihub.v1.Deployment.slo]
  • [environment][google.cloud.apihub.v1.Deployment.environment]
  • [attributes][google.cloud.apihub.v1.Deployment.attributes]

The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDeployment

A Task containing the RPC response.
Overrides

UpdateExternalApi(UpdateExternalApiRequest, CallSettings)

public override ExternalApi UpdateExternalApi(UpdateExternalApiRequest request, CallSettings callSettings = null)

Update an External API resource in the API hub. The following fields can be updated:

  • [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
  • [description][google.cloud.apihub.v1.ExternalApi.description]
  • [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
  • [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
  • [paths][google.cloud.apihub.v1.ExternalApi.paths]

The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ExternalApi

The RPC response.
Overrides

UpdateExternalApiAsync(UpdateExternalApiRequest, CallSettings)

public override Task<ExternalApi> UpdateExternalApiAsync(UpdateExternalApiRequest request, CallSettings callSettings = null)

Update an External API resource in the API hub. The following fields can be updated:

  • [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
  • [description][google.cloud.apihub.v1.ExternalApi.description]
  • [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
  • [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
  • [paths][google.cloud.apihub.v1.ExternalApi.paths]

The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateExternalApiRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExternalApi

A Task containing the RPC response.
Overrides

UpdateSpec(UpdateSpecRequest, CallSettings)

public override Spec UpdateSpec(UpdateSpecRequest request, CallSettings callSettings = null)

Update spec. The following fields in the [spec][google.cloud.apihub.v1.Spec] can be updated:

  • [display_name][google.cloud.apihub.v1.Spec.display_name]
  • [source_uri][google.cloud.apihub.v1.Spec.source_uri]
  • [lint_response][google.cloud.apihub.v1.Spec.lint_response]
  • [attributes][google.cloud.apihub.v1.Spec.attributes]
  • [contents][google.cloud.apihub.v1.Spec.contents]
  • [spec_type][google.cloud.apihub.v1.Spec.spec_type]

In case of an OAS spec, updating spec contents can lead to:

  1. Creation, deletion and update of operations.
  2. Creation, deletion and update of definitions.
  3. Update of other info parsed out from the new spec.

In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present.

The [update_mask][google.cloud.apihub.v1.UpdateSpecRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Spec

The RPC response.
Overrides

UpdateSpecAsync(UpdateSpecRequest, CallSettings)

public override Task<Spec> UpdateSpecAsync(UpdateSpecRequest request, CallSettings callSettings = null)

Update spec. The following fields in the [spec][google.cloud.apihub.v1.Spec] can be updated:

  • [display_name][google.cloud.apihub.v1.Spec.display_name]
  • [source_uri][google.cloud.apihub.v1.Spec.source_uri]
  • [lint_response][google.cloud.apihub.v1.Spec.lint_response]
  • [attributes][google.cloud.apihub.v1.Spec.attributes]
  • [contents][google.cloud.apihub.v1.Spec.contents]
  • [spec_type][google.cloud.apihub.v1.Spec.spec_type]

In case of an OAS spec, updating spec contents can lead to:

  1. Creation, deletion and update of operations.
  2. Creation, deletion and update of definitions.
  3. Update of other info parsed out from the new spec.

In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present.

The [update_mask][google.cloud.apihub.v1.UpdateSpecRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateSpecRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSpec

A Task containing the RPC response.
Overrides

UpdateVersion(UpdateVersionRequest, CallSettings)

public override Version UpdateVersion(UpdateVersionRequest request, CallSettings callSettings = null)

Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently:

  • [display_name][google.cloud.apihub.v1.Version.display_name]
  • [description][google.cloud.apihub.v1.Version.description]
  • [documentation][google.cloud.apihub.v1.Version.documentation]
  • [deployments][google.cloud.apihub.v1.Version.deployments]
  • [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
  • [compliance][google.cloud.apihub.v1.Version.compliance]
  • [accreditation][google.cloud.apihub.v1.Version.accreditation]
  • [attributes][google.cloud.apihub.v1.Version.attributes]

The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Version

The RPC response.
Overrides

UpdateVersionAsync(UpdateVersionRequest, CallSettings)

public override Task<Version> UpdateVersionAsync(UpdateVersionRequest request, CallSettings callSettings = null)

Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently:

  • [display_name][google.cloud.apihub.v1.Version.display_name]
  • [description][google.cloud.apihub.v1.Version.description]
  • [documentation][google.cloud.apihub.v1.Version.documentation]
  • [deployments][google.cloud.apihub.v1.Version.deployments]
  • [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
  • [compliance][google.cloud.apihub.v1.Version.compliance]
  • [accreditation][google.cloud.apihub.v1.Version.accreditation]
  • [attributes][google.cloud.apihub.v1.Version.attributes]

The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskVersion

A Task containing the RPC response.
Overrides