public class ApiHub.ApiHubClient : ClientBase<ApiHub.ApiHubClient>
Reference documentation and code samples for the API hub v1 API class ApiHub.ApiHubClient.
Client for ApiHub
Namespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
ApiHubClient()
protected ApiHubClient()
Protected parameterless constructor to allow creation of test doubles.
ApiHubClient(CallInvoker)
public ApiHubClient(CallInvoker callInvoker)
Creates a new client for ApiHub that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
ApiHubClient(ChannelBase)
public ApiHubClient(ChannelBase channel)
Creates a new client for ApiHub
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
ApiHubClient(ClientBaseConfiguration)
protected ApiHubClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
CreateApi(CreateApiRequest, CallOptions)
public virtual Api CreateApi(CreateApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Api |
The response received from the server. |
CreateApi(CreateApiRequest, Metadata, DateTime?, CancellationToken)
public virtual Api CreateApi(CreateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Api |
The response received from the server. |
CreateApiAsync(CreateApiRequest, CallOptions)
public virtual AsyncUnaryCall<Api> CreateApiAsync(CreateApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApi |
The call object. |
CreateApiAsync(CreateApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Api> CreateApiAsync(CreateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApi |
The call object. |
CreateAttribute(CreateAttributeRequest, CallOptions)
public virtual Attribute CreateAttribute(CreateAttributeRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Attribute |
The response received from the server. |
CreateAttribute(CreateAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual Attribute CreateAttribute(CreateAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Attribute |
The response received from the server. |
CreateAttributeAsync(CreateAttributeRequest, CallOptions)
public virtual AsyncUnaryCall<Attribute> CreateAttributeAsync(CreateAttributeRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAttribute |
The call object. |
CreateAttributeAsync(CreateAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Attribute> CreateAttributeAsync(CreateAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAttribute |
The call object. |
CreateDeployment(CreateDeploymentRequest, CallOptions)
public virtual Deployment CreateDeployment(CreateDeploymentRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Deployment |
The response received from the server. |
CreateDeployment(CreateDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual Deployment CreateDeployment(CreateDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Deployment |
The response received from the server. |
CreateDeploymentAsync(CreateDeploymentRequest, CallOptions)
public virtual AsyncUnaryCall<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDeployment |
The call object. |
CreateDeploymentAsync(CreateDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDeployment |
The call object. |
CreateExternalApi(CreateExternalApiRequest, CallOptions)
public virtual ExternalApi CreateExternalApi(CreateExternalApiRequest request, CallOptions options)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateExternalApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The response received from the server. |
CreateExternalApi(CreateExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual ExternalApi CreateExternalApi(CreateExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateExternalApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The response received from the server. |
CreateExternalApiAsync(CreateExternalApiRequest, CallOptions)
public virtual AsyncUnaryCall<ExternalApi> CreateExternalApiAsync(CreateExternalApiRequest request, CallOptions options)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateExternalApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExternalApi |
The call object. |
CreateExternalApiAsync(CreateExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ExternalApi> CreateExternalApiAsync(CreateExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateExternalApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExternalApi |
The call object. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()
Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateSpec(CreateSpecRequest, CallOptions)
public virtual Spec CreateSpec(CreateSpecRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Spec |
The response received from the server. |
CreateSpec(CreateSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual Spec CreateSpec(CreateSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Spec |
The response received from the server. |
CreateSpecAsync(CreateSpecRequest, CallOptions)
public virtual AsyncUnaryCall<Spec> CreateSpecAsync(CreateSpecRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpec |
The call object. |
CreateSpecAsync(CreateSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Spec> CreateSpecAsync(CreateSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpec |
The call object. |
CreateVersion(CreateVersionRequest, CallOptions)
public virtual Version CreateVersion(CreateVersionRequest request, CallOptions options)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateVersionRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Version |
The response received from the server. |
CreateVersion(CreateVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual Version CreateVersion(CreateVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateVersionRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Version |
The response received from the server. |
CreateVersionAsync(CreateVersionRequest, CallOptions)
public virtual AsyncUnaryCall<Version> CreateVersionAsync(CreateVersionRequest request, CallOptions options)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateVersionRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallVersion |
The call object. |
CreateVersionAsync(CreateVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Version> CreateVersionAsync(CreateVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateVersionRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallVersion |
The call object. |
DeleteApi(DeleteApiRequest, CallOptions)
public virtual Empty DeleteApi(DeleteApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteApi(DeleteApiRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteApi(DeleteApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteApiAsync(DeleteApiRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteApiAsync(DeleteApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteApiAsync(DeleteApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteApiAsync(DeleteApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteAttribute(DeleteAttributeRequest, CallOptions)
public virtual Empty DeleteAttribute(DeleteAttributeRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteAttribute(DeleteAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteAttribute(DeleteAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteAttributeAsync(DeleteAttributeRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteAttributeAsync(DeleteAttributeRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteAttributeAsync(DeleteAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteAttributeAsync(DeleteAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteDeployment(DeleteDeploymentRequest, CallOptions)
public virtual Empty DeleteDeployment(DeleteDeploymentRequest request, CallOptions options)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteDeploymentRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteDeployment(DeleteDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteDeployment(DeleteDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteDeploymentRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteDeploymentAsync(DeleteDeploymentRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteDeploymentAsync(DeleteDeploymentRequest request, CallOptions options)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteDeploymentRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteDeploymentAsync(DeleteDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteDeploymentAsync(DeleteDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteDeploymentRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteExternalApi(DeleteExternalApiRequest, CallOptions)
public virtual Empty DeleteExternalApi(DeleteExternalApiRequest request, CallOptions options)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteExternalApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteExternalApi(DeleteExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteExternalApi(DeleteExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteExternalApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteExternalApiAsync(DeleteExternalApiRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteExternalApiAsync(DeleteExternalApiRequest request, CallOptions options)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteExternalApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteExternalApiAsync(DeleteExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteExternalApiAsync(DeleteExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteExternalApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteSpec(DeleteSpecRequest, CallOptions)
public virtual Empty DeleteSpec(DeleteSpecRequest request, CallOptions options)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
request |
DeleteSpecRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteSpec(DeleteSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteSpec(DeleteSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
request |
DeleteSpecRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteSpecAsync(DeleteSpecRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteSpecAsync(DeleteSpecRequest request, CallOptions options)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
request |
DeleteSpecRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteSpecAsync(DeleteSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteSpecAsync(DeleteSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
request |
DeleteSpecRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteVersion(DeleteVersionRequest, CallOptions)
public virtual Empty DeleteVersion(DeleteVersionRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteVersion(DeleteVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteVersion(DeleteVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteVersionAsync(DeleteVersionRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteVersionAsync(DeleteVersionRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteVersionAsync(DeleteVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteVersionAsync(DeleteVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
GetApi(GetApiRequest, CallOptions)
public virtual Api GetApi(GetApiRequest request, CallOptions options)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Api |
The response received from the server. |
GetApi(GetApiRequest, Metadata, DateTime?, CancellationToken)
public virtual Api GetApi(GetApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Api |
The response received from the server. |
GetApiAsync(GetApiRequest, CallOptions)
public virtual AsyncUnaryCall<Api> GetApiAsync(GetApiRequest request, CallOptions options)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApi |
The call object. |
GetApiAsync(GetApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Api> GetApiAsync(GetApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApi |
The call object. |
GetApiOperation(GetApiOperationRequest, CallOptions)
public virtual ApiOperation GetApiOperation(GetApiOperationRequest request, CallOptions options)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
request |
GetApiOperationRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ApiOperation |
The response received from the server. |
GetApiOperation(GetApiOperationRequest, Metadata, DateTime?, CancellationToken)
public virtual ApiOperation GetApiOperation(GetApiOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
request |
GetApiOperationRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ApiOperation |
The response received from the server. |
GetApiOperationAsync(GetApiOperationRequest, CallOptions)
public virtual AsyncUnaryCall<ApiOperation> GetApiOperationAsync(GetApiOperationRequest request, CallOptions options)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
request |
GetApiOperationRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApiOperation |
The call object. |
GetApiOperationAsync(GetApiOperationRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ApiOperation> GetApiOperationAsync(GetApiOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
request |
GetApiOperationRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApiOperation |
The call object. |
GetAttribute(GetAttributeRequest, CallOptions)
public virtual Attribute GetAttribute(GetAttributeRequest request, CallOptions options)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
request |
GetAttributeRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Attribute |
The response received from the server. |
GetAttribute(GetAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual Attribute GetAttribute(GetAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
request |
GetAttributeRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Attribute |
The response received from the server. |
GetAttributeAsync(GetAttributeRequest, CallOptions)
public virtual AsyncUnaryCall<Attribute> GetAttributeAsync(GetAttributeRequest request, CallOptions options)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
request |
GetAttributeRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAttribute |
The call object. |
GetAttributeAsync(GetAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Attribute> GetAttributeAsync(GetAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
request |
GetAttributeRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAttribute |
The call object. |
GetDefinition(GetDefinitionRequest, CallOptions)
public virtual Definition GetDefinition(GetDefinitionRequest request, CallOptions options)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
request |
GetDefinitionRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Definition |
The response received from the server. |
GetDefinition(GetDefinitionRequest, Metadata, DateTime?, CancellationToken)
public virtual Definition GetDefinition(GetDefinitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
request |
GetDefinitionRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Definition |
The response received from the server. |
GetDefinitionAsync(GetDefinitionRequest, CallOptions)
public virtual AsyncUnaryCall<Definition> GetDefinitionAsync(GetDefinitionRequest request, CallOptions options)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
request |
GetDefinitionRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDefinition |
The call object. |
GetDefinitionAsync(GetDefinitionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Definition> GetDefinitionAsync(GetDefinitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
request |
GetDefinitionRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDefinition |
The call object. |
GetDeployment(GetDeploymentRequest, CallOptions)
public virtual Deployment GetDeployment(GetDeploymentRequest request, CallOptions options)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Deployment |
The response received from the server. |
GetDeployment(GetDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual Deployment GetDeployment(GetDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Deployment |
The response received from the server. |
GetDeploymentAsync(GetDeploymentRequest, CallOptions)
public virtual AsyncUnaryCall<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CallOptions options)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDeployment |
The call object. |
GetDeploymentAsync(GetDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Deployment> GetDeploymentAsync(GetDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDeployment |
The call object. |
GetExternalApi(GetExternalApiRequest, CallOptions)
public virtual ExternalApi GetExternalApi(GetExternalApiRequest request, CallOptions options)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
GetExternalApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The response received from the server. |
GetExternalApi(GetExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual ExternalApi GetExternalApi(GetExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
GetExternalApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The response received from the server. |
GetExternalApiAsync(GetExternalApiRequest, CallOptions)
public virtual AsyncUnaryCall<ExternalApi> GetExternalApiAsync(GetExternalApiRequest request, CallOptions options)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
GetExternalApiRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExternalApi |
The call object. |
GetExternalApiAsync(GetExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ExternalApi> GetExternalApiAsync(GetExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
GetExternalApiRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExternalApi |
The call object. |
GetSpec(GetSpecRequest, CallOptions)
public virtual Spec GetSpec(GetSpecRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Spec |
The response received from the server. |
GetSpec(GetSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual Spec GetSpec(GetSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Spec |
The response received from the server. |
GetSpecAsync(GetSpecRequest, CallOptions)
public virtual AsyncUnaryCall<Spec> GetSpecAsync(GetSpecRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpec |
The call object. |
GetSpecAsync(GetSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Spec> GetSpecAsync(GetSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpec |
The call object. |
GetSpecContents(GetSpecContentsRequest, CallOptions)
public virtual SpecContents GetSpecContents(GetSpecContentsRequest request, CallOptions options)
Get spec contents.
Parameters | |
---|---|
Name | Description |
request |
GetSpecContentsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SpecContents |
The response received from the server. |
GetSpecContents(GetSpecContentsRequest, Metadata, DateTime?, CancellationToken)
public virtual SpecContents GetSpecContents(GetSpecContentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get spec contents.
Parameters | |
---|---|
Name | Description |
request |
GetSpecContentsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
SpecContents |
The response received from the server. |
GetSpecContentsAsync(GetSpecContentsRequest, CallOptions)
public virtual AsyncUnaryCall<SpecContents> GetSpecContentsAsync(GetSpecContentsRequest request, CallOptions options)
Get spec contents.
Parameters | |
---|---|
Name | Description |
request |
GetSpecContentsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpecContents |
The call object. |
GetSpecContentsAsync(GetSpecContentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SpecContents> GetSpecContentsAsync(GetSpecContentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get spec contents.
Parameters | |
---|---|
Name | Description |
request |
GetSpecContentsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpecContents |
The call object. |
GetVersion(GetVersionRequest, CallOptions)
public virtual Version GetVersion(GetVersionRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Version |
The response received from the server. |
GetVersion(GetVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual Version GetVersion(GetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Version |
The response received from the server. |
GetVersionAsync(GetVersionRequest, CallOptions)
public virtual AsyncUnaryCall<Version> GetVersionAsync(GetVersionRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallVersion |
The call object. |
GetVersionAsync(GetVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Version> GetVersionAsync(GetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallVersion |
The call object. |
ListApiOperations(ListApiOperationsRequest, CallOptions)
public virtual ListApiOperationsResponse ListApiOperations(ListApiOperationsRequest request, CallOptions options)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
request |
ListApiOperationsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListApiOperationsResponse |
The response received from the server. |
ListApiOperations(ListApiOperationsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListApiOperationsResponse ListApiOperations(ListApiOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
request |
ListApiOperationsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListApiOperationsResponse |
The response received from the server. |
ListApiOperationsAsync(ListApiOperationsRequest, CallOptions)
public virtual AsyncUnaryCall<ListApiOperationsResponse> ListApiOperationsAsync(ListApiOperationsRequest request, CallOptions options)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
request |
ListApiOperationsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListApiOperationsResponse |
The call object. |
ListApiOperationsAsync(ListApiOperationsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListApiOperationsResponse> ListApiOperationsAsync(ListApiOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
request |
ListApiOperationsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListApiOperationsResponse |
The call object. |
ListApis(ListApisRequest, CallOptions)
public virtual ListApisResponse ListApis(ListApisRequest request, CallOptions options)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListApisRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListApisResponse |
The response received from the server. |
ListApis(ListApisRequest, Metadata, DateTime?, CancellationToken)
public virtual ListApisResponse ListApis(ListApisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListApisRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListApisResponse |
The response received from the server. |
ListApisAsync(ListApisRequest, CallOptions)
public virtual AsyncUnaryCall<ListApisResponse> ListApisAsync(ListApisRequest request, CallOptions options)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListApisRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListApisResponse |
The call object. |
ListApisAsync(ListApisRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListApisResponse> ListApisAsync(ListApisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListApisRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListApisResponse |
The call object. |
ListAttributes(ListAttributesRequest, CallOptions)
public virtual ListAttributesResponse ListAttributes(ListAttributesRequest request, CallOptions options)
List all attributes.
Parameters | |
---|---|
Name | Description |
request |
ListAttributesRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListAttributesResponse |
The response received from the server. |
ListAttributes(ListAttributesRequest, Metadata, DateTime?, CancellationToken)
public virtual ListAttributesResponse ListAttributes(ListAttributesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List all attributes.
Parameters | |
---|---|
Name | Description |
request |
ListAttributesRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListAttributesResponse |
The response received from the server. |
ListAttributesAsync(ListAttributesRequest, CallOptions)
public virtual AsyncUnaryCall<ListAttributesResponse> ListAttributesAsync(ListAttributesRequest request, CallOptions options)
List all attributes.
Parameters | |
---|---|
Name | Description |
request |
ListAttributesRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListAttributesResponse |
The call object. |
ListAttributesAsync(ListAttributesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListAttributesResponse> ListAttributesAsync(ListAttributesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List all attributes.
Parameters | |
---|---|
Name | Description |
request |
ListAttributesRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListAttributesResponse |
The call object. |
ListDeployments(ListDeploymentsRequest, CallOptions)
public virtual ListDeploymentsResponse ListDeployments(ListDeploymentsRequest request, CallOptions options)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListDeploymentsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListDeploymentsResponse |
The response received from the server. |
ListDeployments(ListDeploymentsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListDeploymentsResponse ListDeployments(ListDeploymentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListDeploymentsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListDeploymentsResponse |
The response received from the server. |
ListDeploymentsAsync(ListDeploymentsRequest, CallOptions)
public virtual AsyncUnaryCall<ListDeploymentsResponse> ListDeploymentsAsync(ListDeploymentsRequest request, CallOptions options)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListDeploymentsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListDeploymentsResponse |
The call object. |
ListDeploymentsAsync(ListDeploymentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListDeploymentsResponse> ListDeploymentsAsync(ListDeploymentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListDeploymentsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListDeploymentsResponse |
The call object. |
ListExternalApis(ListExternalApisRequest, CallOptions)
public virtual ListExternalApisResponse ListExternalApis(ListExternalApisRequest request, CallOptions options)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListExternalApisRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListExternalApisResponse |
The response received from the server. |
ListExternalApis(ListExternalApisRequest, Metadata, DateTime?, CancellationToken)
public virtual ListExternalApisResponse ListExternalApis(ListExternalApisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListExternalApisRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListExternalApisResponse |
The response received from the server. |
ListExternalApisAsync(ListExternalApisRequest, CallOptions)
public virtual AsyncUnaryCall<ListExternalApisResponse> ListExternalApisAsync(ListExternalApisRequest request, CallOptions options)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListExternalApisRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListExternalApisResponse |
The call object. |
ListExternalApisAsync(ListExternalApisRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListExternalApisResponse> ListExternalApisAsync(ListExternalApisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListExternalApisRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListExternalApisResponse |
The call object. |
ListSpecs(ListSpecsRequest, CallOptions)
public virtual ListSpecsResponse ListSpecs(ListSpecsRequest request, CallOptions options)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
request |
ListSpecsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListSpecsResponse |
The response received from the server. |
ListSpecs(ListSpecsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListSpecsResponse ListSpecs(ListSpecsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
request |
ListSpecsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListSpecsResponse |
The response received from the server. |
ListSpecsAsync(ListSpecsRequest, CallOptions)
public virtual AsyncUnaryCall<ListSpecsResponse> ListSpecsAsync(ListSpecsRequest request, CallOptions options)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
request |
ListSpecsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListSpecsResponse |
The call object. |
ListSpecsAsync(ListSpecsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListSpecsResponse> ListSpecsAsync(ListSpecsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
request |
ListSpecsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListSpecsResponse |
The call object. |
ListVersions(ListVersionsRequest, CallOptions)
public virtual ListVersionsResponse ListVersions(ListVersionsRequest request, CallOptions options)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListVersionsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListVersionsResponse |
The response received from the server. |
ListVersions(ListVersionsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListVersionsResponse ListVersions(ListVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListVersionsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListVersionsResponse |
The response received from the server. |
ListVersionsAsync(ListVersionsRequest, CallOptions)
public virtual AsyncUnaryCall<ListVersionsResponse> ListVersionsAsync(ListVersionsRequest request, CallOptions options)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListVersionsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListVersionsResponse |
The call object. |
ListVersionsAsync(ListVersionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListVersionsResponse> ListVersionsAsync(ListVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListVersionsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListVersionsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override ApiHub.ApiHubClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
ApiHubApiHubClient |
SearchResources(SearchResourcesRequest, CallOptions)
public virtual SearchResourcesResponse SearchResources(SearchResourcesRequest request, CallOptions options)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
request |
SearchResourcesRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SearchResourcesResponse |
The response received from the server. |
SearchResources(SearchResourcesRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchResourcesResponse SearchResources(SearchResourcesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
request |
SearchResourcesRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
SearchResourcesResponse |
The response received from the server. |
SearchResourcesAsync(SearchResourcesRequest, CallOptions)
public virtual AsyncUnaryCall<SearchResourcesResponse> SearchResourcesAsync(SearchResourcesRequest request, CallOptions options)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
request |
SearchResourcesRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSearchResourcesResponse |
The call object. |
SearchResourcesAsync(SearchResourcesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchResourcesResponse> SearchResourcesAsync(SearchResourcesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
request |
SearchResourcesRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSearchResourcesResponse |
The call object. |
UpdateApi(UpdateApiRequest, CallOptions)
public virtual Api UpdateApi(UpdateApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Api |
The response received from the server. |
UpdateApi(UpdateApiRequest, Metadata, DateTime?, CancellationToken)
public virtual Api UpdateApi(UpdateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Api |
The response received from the server. |
UpdateApiAsync(UpdateApiRequest, CallOptions)
public virtual AsyncUnaryCall<Api> UpdateApiAsync(UpdateApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApi |
The call object. |
UpdateApiAsync(UpdateApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Api> UpdateApiAsync(UpdateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallApi |
The call object. |
UpdateAttribute(UpdateAttributeRequest, CallOptions)
public virtual Attribute UpdateAttribute(UpdateAttributeRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Attribute |
The response received from the server. |
UpdateAttribute(UpdateAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual Attribute UpdateAttribute(UpdateAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Attribute |
The response received from the server. |
UpdateAttributeAsync(UpdateAttributeRequest, CallOptions)
public virtual AsyncUnaryCall<Attribute> UpdateAttributeAsync(UpdateAttributeRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAttribute |
The call object. |
UpdateAttributeAsync(UpdateAttributeRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Attribute> UpdateAttributeAsync(UpdateAttributeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAttribute |
The call object. |
UpdateDeployment(UpdateDeploymentRequest, CallOptions)
public virtual Deployment UpdateDeployment(UpdateDeploymentRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Deployment |
The response received from the server. |
UpdateDeployment(UpdateDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual Deployment UpdateDeployment(UpdateDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Deployment |
The response received from the server. |
UpdateDeploymentAsync(UpdateDeploymentRequest, CallOptions)
public virtual AsyncUnaryCall<Deployment> UpdateDeploymentAsync(UpdateDeploymentRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDeployment |
The call object. |
UpdateDeploymentAsync(UpdateDeploymentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Deployment> UpdateDeploymentAsync(UpdateDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDeployment |
The call object. |
UpdateExternalApi(UpdateExternalApiRequest, CallOptions)
public virtual ExternalApi UpdateExternalApi(UpdateExternalApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The response received from the server. |
UpdateExternalApi(UpdateExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual ExternalApi UpdateExternalApi(UpdateExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The response received from the server. |
UpdateExternalApiAsync(UpdateExternalApiRequest, CallOptions)
public virtual AsyncUnaryCall<ExternalApi> UpdateExternalApiAsync(UpdateExternalApiRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExternalApi |
The call object. |
UpdateExternalApiAsync(UpdateExternalApiRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ExternalApi> UpdateExternalApiAsync(UpdateExternalApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExternalApi |
The call object. |
UpdateSpec(UpdateSpecRequest, CallOptions)
public virtual Spec UpdateSpec(UpdateSpecRequest request, CallOptions options)
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:
- Creation, deletion and update of operations.
- Creation, deletion and update of definitions.
- 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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Spec |
The response received from the server. |
UpdateSpec(UpdateSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual Spec UpdateSpec(UpdateSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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:
- Creation, deletion and update of operations.
- Creation, deletion and update of definitions.
- 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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Spec |
The response received from the server. |
UpdateSpecAsync(UpdateSpecRequest, CallOptions)
public virtual AsyncUnaryCall<Spec> UpdateSpecAsync(UpdateSpecRequest request, CallOptions options)
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:
- Creation, deletion and update of operations.
- Creation, deletion and update of definitions.
- 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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpec |
The call object. |
UpdateSpecAsync(UpdateSpecRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Spec> UpdateSpecAsync(UpdateSpecRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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:
- Creation, deletion and update of operations.
- Creation, deletion and update of definitions.
- 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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSpec |
The call object. |
UpdateVersion(UpdateVersionRequest, CallOptions)
public virtual Version UpdateVersion(UpdateVersionRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Version |
The response received from the server. |
UpdateVersion(UpdateVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual Version UpdateVersion(UpdateVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Version |
The response received from the server. |
UpdateVersionAsync(UpdateVersionRequest, CallOptions)
public virtual AsyncUnaryCall<Version> UpdateVersionAsync(UpdateVersionRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallVersion |
The call object. |
UpdateVersionAsync(UpdateVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Version> UpdateVersionAsync(UpdateVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallVersion |
The call object. |