public abstract class ApiHubClient
Reference documentation and code samples for the API hub v1 API class ApiHubClient.
ApiHub client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Remarks
This service provides all methods related to the API hub.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the ApiHub service, which is a host of "apihub.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default ApiHub scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default ApiHub scopes are:
GrpcClient
public virtual ApiHub.ApiHubClient GrpcClient { get; }
The underlying gRPC ApiHub client
Property Value | |
---|---|
Type | Description |
ApiHubApiHubClient |
LocationsClient
public virtual LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
Create()
public static ApiHubClient Create()
Synchronously creates a ApiHubClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ApiHubClientBuilder.
Returns | |
---|---|
Type | Description |
ApiHubClient |
The created ApiHubClient. |
CreateApi(LocationName, Api, string, CallSettings)
public virtual Api CreateApi(LocationName parent, Api api, string apiId, CallSettings callSettings = null)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the API resource.
Format: |
api |
Api Required. The API resource to create. |
apiId |
string Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
gcav::Api response = apiHubClient.CreateApi(parent, api, apiId);
CreateApi(CreateApiRequest, CallSettings)
public virtual Api CreateApi(CreateApiRequest request, CallSettings callSettings = null)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
request |
CreateApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::CreateApiRequest request = new gcav::CreateApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ApiId = "",
Api = new gcav::Api(),
};
// Make the request
gcav::Api response = apiHubClient.CreateApi(request);
CreateApi(string, Api, string, CallSettings)
public virtual Api CreateApi(string parent, Api api, string apiId, CallSettings callSettings = null)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the API resource.
Format: |
api |
Api Required. The API resource to create. |
apiId |
string Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
gcav::Api response = apiHubClient.CreateApi(parent, api, apiId);
CreateApiAsync(LocationName, Api, string, CallSettings)
public virtual Task<Api> CreateApiAsync(LocationName parent, Api api, string apiId, CallSettings callSettings = null)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the API resource.
Format: |
api |
Api Required. The API resource to create. |
apiId |
string Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
gcav::Api response = await apiHubClient.CreateApiAsync(parent, api, apiId);
CreateApiAsync(LocationName, Api, string, CancellationToken)
public virtual Task<Api> CreateApiAsync(LocationName parent, Api api, string apiId, CancellationToken cancellationToken)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the API resource.
Format: |
api |
Api Required. The API resource to create. |
apiId |
string Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
gcav::Api response = await apiHubClient.CreateApiAsync(parent, api, apiId);
CreateApiAsync(CreateApiRequest, CallSettings)
public virtual Task<Api> CreateApiAsync(CreateApiRequest request, CallSettings callSettings = null)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
request |
CreateApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateApiRequest request = new gcav::CreateApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ApiId = "",
Api = new gcav::Api(),
};
// Make the request
gcav::Api response = await apiHubClient.CreateApiAsync(request);
CreateApiAsync(CreateApiRequest, CancellationToken)
public virtual Task<Api> CreateApiAsync(CreateApiRequest request, CancellationToken cancellationToken)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
request |
CreateApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateApiRequest request = new gcav::CreateApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ApiId = "",
Api = new gcav::Api(),
};
// Make the request
gcav::Api response = await apiHubClient.CreateApiAsync(request);
CreateApiAsync(string, Api, string, CallSettings)
public virtual Task<Api> CreateApiAsync(string parent, Api api, string apiId, CallSettings callSettings = null)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the API resource.
Format: |
api |
Api Required. The API resource to create. |
apiId |
string Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
gcav::Api response = await apiHubClient.CreateApiAsync(parent, api, apiId);
CreateApiAsync(string, Api, string, CancellationToken)
public virtual Task<Api> CreateApiAsync(string parent, Api api, string apiId, CancellationToken cancellationToken)
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the API resource.
Format: |
api |
Api Required. The API resource to create. |
apiId |
string Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
gcav::Api response = await apiHubClient.CreateApiAsync(parent, api, apiId);
CreateAsync(CancellationToken)
public static Task<ApiHubClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a ApiHubClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ApiHubClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken |
CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskApiHubClient |
The task representing the created ApiHubClient. |
CreateAttribute(LocationName, Attribute, string, CallSettings)
public virtual Attribute CreateAttribute(LocationName parent, Attribute attribute, string attributeId, CallSettings callSettings = null)
Create a user defined attribute.
Certain pre defined attributes are already created by the API hub. These
attributes will have type as SYSTEM_DEFINED
and can be listed via
[ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
Allowed values for the same can be updated via
[UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for Attribute.
Format: |
attribute |
Attribute Required. The attribute to create. |
attributeId |
string Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Attribute attribute = new gcav::Attribute();
string attributeId = "";
// Make the request
gcav::Attribute response = apiHubClient.CreateAttribute(parent, attribute, attributeId);
CreateAttribute(CreateAttributeRequest, CallSettings)
public virtual Attribute CreateAttribute(CreateAttributeRequest request, CallSettings callSettings = null)
Create a user defined attribute.
Certain pre defined attributes are already created by the API hub. These
attributes will have type as SYSTEM_DEFINED
and can be listed via
[ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
Allowed values for the same can be updated via
[UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
Parameters | |
---|---|
Name | Description |
request |
CreateAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::CreateAttributeRequest request = new gcav::CreateAttributeRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
AttributeId = "",
Attribute = new gcav::Attribute(),
};
// Make the request
gcav::Attribute response = apiHubClient.CreateAttribute(request);
CreateAttribute(string, Attribute, string, CallSettings)
public virtual Attribute CreateAttribute(string parent, Attribute attribute, string attributeId, CallSettings callSettings = null)
Create a user defined attribute.
Certain pre defined attributes are already created by the API hub. These
attributes will have type as SYSTEM_DEFINED
and can be listed via
[ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
Allowed values for the same can be updated via
[UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for Attribute.
Format: |
attribute |
Attribute Required. The attribute to create. |
attributeId |
string Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Attribute attribute = new gcav::Attribute();
string attributeId = "";
// Make the request
gcav::Attribute response = apiHubClient.CreateAttribute(parent, attribute, attributeId);
CreateAttributeAsync(LocationName, Attribute, string, CallSettings)
public virtual Task<Attribute> CreateAttributeAsync(LocationName parent, Attribute attribute, string attributeId, CallSettings callSettings = null)
Create a user defined attribute.
Certain pre defined attributes are already created by the API hub. These
attributes will have type as SYSTEM_DEFINED
and can be listed via
[ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
Allowed values for the same can be updated via
[UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for Attribute.
Format: |
attribute |
Attribute Required. The attribute to create. |
attributeId |
string Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Attribute attribute = new gcav::Attribute();
string attributeId = "";
// Make the request
gcav::Attribute response = await apiHubClient.CreateAttributeAsync(parent, attribute, attributeId);
CreateAttributeAsync(LocationName, Attribute, string, CancellationToken)
public virtual Task<Attribute> CreateAttributeAsync(LocationName parent, Attribute attribute, string attributeId, CancellationToken cancellationToken)
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 |
parent |
LocationName Required. The parent resource for Attribute.
Format: |
attribute |
Attribute Required. The attribute to create. |
attributeId |
string Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Attribute attribute = new gcav::Attribute();
string attributeId = "";
// Make the request
gcav::Attribute response = await apiHubClient.CreateAttributeAsync(parent, attribute, attributeId);
CreateAttributeAsync(CreateAttributeRequest, CallSettings)
public virtual Task<Attribute> CreateAttributeAsync(CreateAttributeRequest request, CallSettings callSettings = null)
Create a user defined attribute.
Certain pre defined attributes are already created by the API hub. These
attributes will have type as SYSTEM_DEFINED
and can be listed via
[ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
Allowed values for the same can be updated via
[UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
Parameters | |
---|---|
Name | Description |
request |
CreateAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateAttributeRequest request = new gcav::CreateAttributeRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
AttributeId = "",
Attribute = new gcav::Attribute(),
};
// Make the request
gcav::Attribute response = await apiHubClient.CreateAttributeAsync(request);
CreateAttributeAsync(CreateAttributeRequest, CancellationToken)
public virtual Task<Attribute> CreateAttributeAsync(CreateAttributeRequest request, CancellationToken cancellationToken)
Create a user defined attribute.
Certain pre defined attributes are already created by the API hub. These
attributes will have type as SYSTEM_DEFINED
and can be listed via
[ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
Allowed values for the same can be updated via
[UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
Parameters | |
---|---|
Name | Description |
request |
CreateAttributeRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateAttributeRequest request = new gcav::CreateAttributeRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
AttributeId = "",
Attribute = new gcav::Attribute(),
};
// Make the request
gcav::Attribute response = await apiHubClient.CreateAttributeAsync(request);
CreateAttributeAsync(string, Attribute, string, CallSettings)
public virtual Task<Attribute> CreateAttributeAsync(string parent, Attribute attribute, string attributeId, CallSettings callSettings = null)
Create a user defined attribute.
Certain pre defined attributes are already created by the API hub. These
attributes will have type as SYSTEM_DEFINED
and can be listed via
[ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
Allowed values for the same can be updated via
[UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for Attribute.
Format: |
attribute |
Attribute Required. The attribute to create. |
attributeId |
string Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Attribute attribute = new gcav::Attribute();
string attributeId = "";
// Make the request
gcav::Attribute response = await apiHubClient.CreateAttributeAsync(parent, attribute, attributeId);
CreateAttributeAsync(string, Attribute, string, CancellationToken)
public virtual Task<Attribute> CreateAttributeAsync(string parent, Attribute attribute, string attributeId, CancellationToken cancellationToken)
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 |
parent |
string Required. The parent resource for Attribute.
Format: |
attribute |
Attribute Required. The attribute to create. |
attributeId |
string Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Attribute attribute = new gcav::Attribute();
string attributeId = "";
// Make the request
gcav::Attribute response = await apiHubClient.CreateAttributeAsync(parent, attribute, attributeId);
CreateDeployment(LocationName, Deployment, string, CallSettings)
public virtual Deployment CreateDeployment(LocationName parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the deployment resource.
Format: |
deployment |
Deployment Required. The deployment resource to create. |
deploymentId |
string Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Deployment deployment = new gcav::Deployment();
string deploymentId = "";
// Make the request
gcav::Deployment response = apiHubClient.CreateDeployment(parent, deployment, deploymentId);
CreateDeployment(CreateDeploymentRequest, CallSettings)
public virtual Deployment CreateDeployment(CreateDeploymentRequest request, CallSettings callSettings = null)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
request |
CreateDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::CreateDeploymentRequest request = new gcav::CreateDeploymentRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
DeploymentId = "",
Deployment = new gcav::Deployment(),
};
// Make the request
gcav::Deployment response = apiHubClient.CreateDeployment(request);
CreateDeployment(string, Deployment, string, CallSettings)
public virtual Deployment CreateDeployment(string parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the deployment resource.
Format: |
deployment |
Deployment Required. The deployment resource to create. |
deploymentId |
string Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Deployment deployment = new gcav::Deployment();
string deploymentId = "";
// Make the request
gcav::Deployment response = apiHubClient.CreateDeployment(parent, deployment, deploymentId);
CreateDeploymentAsync(LocationName, Deployment, string, CallSettings)
public virtual Task<Deployment> CreateDeploymentAsync(LocationName parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the deployment resource.
Format: |
deployment |
Deployment Required. The deployment resource to create. |
deploymentId |
string Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Deployment deployment = new gcav::Deployment();
string deploymentId = "";
// Make the request
gcav::Deployment response = await apiHubClient.CreateDeploymentAsync(parent, deployment, deploymentId);
CreateDeploymentAsync(LocationName, Deployment, string, CancellationToken)
public virtual Task<Deployment> CreateDeploymentAsync(LocationName parent, Deployment deployment, string deploymentId, CancellationToken cancellationToken)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the deployment resource.
Format: |
deployment |
Deployment Required. The deployment resource to create. |
deploymentId |
string Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Deployment deployment = new gcav::Deployment();
string deploymentId = "";
// Make the request
gcav::Deployment response = await apiHubClient.CreateDeploymentAsync(parent, deployment, deploymentId);
CreateDeploymentAsync(CreateDeploymentRequest, CallSettings)
public virtual Task<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, CallSettings callSettings = null)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
request |
CreateDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateDeploymentRequest request = new gcav::CreateDeploymentRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
DeploymentId = "",
Deployment = new gcav::Deployment(),
};
// Make the request
gcav::Deployment response = await apiHubClient.CreateDeploymentAsync(request);
CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)
public virtual Task<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, CancellationToken cancellationToken)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
request |
CreateDeploymentRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateDeploymentRequest request = new gcav::CreateDeploymentRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
DeploymentId = "",
Deployment = new gcav::Deployment(),
};
// Make the request
gcav::Deployment response = await apiHubClient.CreateDeploymentAsync(request);
CreateDeploymentAsync(string, Deployment, string, CallSettings)
public virtual Task<Deployment> CreateDeploymentAsync(string parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the deployment resource.
Format: |
deployment |
Deployment Required. The deployment resource to create. |
deploymentId |
string Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Deployment deployment = new gcav::Deployment();
string deploymentId = "";
// Make the request
gcav::Deployment response = await apiHubClient.CreateDeploymentAsync(parent, deployment, deploymentId);
CreateDeploymentAsync(string, Deployment, string, CancellationToken)
public virtual Task<Deployment> CreateDeploymentAsync(string parent, Deployment deployment, string deploymentId, CancellationToken cancellationToken)
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the deployment resource.
Format: |
deployment |
Deployment Required. The deployment resource to create. |
deploymentId |
string Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Deployment deployment = new gcav::Deployment();
string deploymentId = "";
// Make the request
gcav::Deployment response = await apiHubClient.CreateDeploymentAsync(parent, deployment, deploymentId);
CreateExternalApi(LocationName, ExternalApi, string, CallSettings)
public virtual ExternalApi CreateExternalApi(LocationName parent, ExternalApi externalApi, string externalApiId, CallSettings callSettings = null)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the External API resource.
Format: |
externalApi |
ExternalApi Required. The External API resource to create. |
externalApiId |
string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::ExternalApi externalApi = new gcav::ExternalApi();
string externalApiId = "";
// Make the request
gcav::ExternalApi response = apiHubClient.CreateExternalApi(parent, externalApi, externalApiId);
CreateExternalApi(CreateExternalApiRequest, CallSettings)
public virtual ExternalApi CreateExternalApi(CreateExternalApiRequest request, CallSettings callSettings = null)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::CreateExternalApiRequest request = new gcav::CreateExternalApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ExternalApiId = "",
ExternalApi = new gcav::ExternalApi(),
};
// Make the request
gcav::ExternalApi response = apiHubClient.CreateExternalApi(request);
CreateExternalApi(string, ExternalApi, string, CallSettings)
public virtual ExternalApi CreateExternalApi(string parent, ExternalApi externalApi, string externalApiId, CallSettings callSettings = null)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the External API resource.
Format: |
externalApi |
ExternalApi Required. The External API resource to create. |
externalApiId |
string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::ExternalApi externalApi = new gcav::ExternalApi();
string externalApiId = "";
// Make the request
gcav::ExternalApi response = apiHubClient.CreateExternalApi(parent, externalApi, externalApiId);
CreateExternalApiAsync(LocationName, ExternalApi, string, CallSettings)
public virtual Task<ExternalApi> CreateExternalApiAsync(LocationName parent, ExternalApi externalApi, string externalApiId, CallSettings callSettings = null)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the External API resource.
Format: |
externalApi |
ExternalApi Required. The External API resource to create. |
externalApiId |
string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::ExternalApi externalApi = new gcav::ExternalApi();
string externalApiId = "";
// Make the request
gcav::ExternalApi response = await apiHubClient.CreateExternalApiAsync(parent, externalApi, externalApiId);
CreateExternalApiAsync(LocationName, ExternalApi, string, CancellationToken)
public virtual Task<ExternalApi> CreateExternalApiAsync(LocationName parent, ExternalApi externalApi, string externalApiId, CancellationToken cancellationToken)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for the External API resource.
Format: |
externalApi |
ExternalApi Required. The External API resource to create. |
externalApiId |
string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::ExternalApi externalApi = new gcav::ExternalApi();
string externalApiId = "";
// Make the request
gcav::ExternalApi response = await apiHubClient.CreateExternalApiAsync(parent, externalApi, externalApiId);
CreateExternalApiAsync(CreateExternalApiRequest, CallSettings)
public virtual Task<ExternalApi> CreateExternalApiAsync(CreateExternalApiRequest request, CallSettings callSettings = null)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateExternalApiRequest request = new gcav::CreateExternalApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ExternalApiId = "",
ExternalApi = new gcav::ExternalApi(),
};
// Make the request
gcav::ExternalApi response = await apiHubClient.CreateExternalApiAsync(request);
CreateExternalApiAsync(CreateExternalApiRequest, CancellationToken)
public virtual Task<ExternalApi> CreateExternalApiAsync(CreateExternalApiRequest request, CancellationToken cancellationToken)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateExternalApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateExternalApiRequest request = new gcav::CreateExternalApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ExternalApiId = "",
ExternalApi = new gcav::ExternalApi(),
};
// Make the request
gcav::ExternalApi response = await apiHubClient.CreateExternalApiAsync(request);
CreateExternalApiAsync(string, ExternalApi, string, CallSettings)
public virtual Task<ExternalApi> CreateExternalApiAsync(string parent, ExternalApi externalApi, string externalApiId, CallSettings callSettings = null)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the External API resource.
Format: |
externalApi |
ExternalApi Required. The External API resource to create. |
externalApiId |
string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::ExternalApi externalApi = new gcav::ExternalApi();
string externalApiId = "";
// Make the request
gcav::ExternalApi response = await apiHubClient.CreateExternalApiAsync(parent, externalApi, externalApiId);
CreateExternalApiAsync(string, ExternalApi, string, CancellationToken)
public virtual Task<ExternalApi> CreateExternalApiAsync(string parent, ExternalApi externalApi, string externalApiId, CancellationToken cancellationToken)
Create an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for the External API resource.
Format: |
externalApi |
ExternalApi Required. The External API resource to create. |
externalApiId |
string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::ExternalApi externalApi = new gcav::ExternalApi();
string externalApiId = "";
// Make the request
gcav::ExternalApi response = await apiHubClient.CreateExternalApiAsync(parent, externalApi, externalApiId);
CreateSpec(CreateSpecRequest, CallSettings)
public virtual Spec CreateSpec(CreateSpecRequest request, CallSettings callSettings = null)
Add a spec to an API version in the API hub.
Multiple specs can be added to an API version.
Note, while adding a spec, at least one of contents
or source_uri
must
be provided. If contents
is provided, then spec_type
must also be
provided.
On adding a spec with contents to the version, the operations present in it
will be added to the version.Note that the file contents in the spec should
be of the same type as defined in the
projects/{project}/locations/{location}/attributes/system-spec-type
attribute associated with spec resource. Note that specs of various types
can be uploaded, however parsing of details is supported for OpenAPI spec
currently.
In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
Parameters | |
---|---|
Name | Description |
request |
CreateSpecRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::CreateSpecRequest request = new gcav::CreateSpecRequest
{
ParentAsVersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
SpecId = "",
Spec = new gcav::Spec(),
};
// Make the request
gcav::Spec response = apiHubClient.CreateSpec(request);
CreateSpec(VersionName, Spec, string, CallSettings)
public virtual Spec CreateSpec(VersionName parent, Spec spec, string specId, CallSettings callSettings = null)
Add a spec to an API version in the API hub.
Multiple specs can be added to an API version.
Note, while adding a spec, at least one of contents
or source_uri
must
be provided. If contents
is provided, then spec_type
must also be
provided.
On adding a spec with contents to the version, the operations present in it
will be added to the version.Note that the file contents in the spec should
be of the same type as defined in the
projects/{project}/locations/{location}/attributes/system-spec-type
attribute associated with spec resource. Note that specs of various types
can be uploaded, however parsing of details is supported for OpenAPI spec
currently.
In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
Parameters | |
---|---|
Name | Description |
parent |
VersionName Required. The parent resource for Spec.
Format:
|
spec |
Spec Required. The spec to create. |
specId |
string Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::VersionName parent = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
gcav::Spec spec = new gcav::Spec();
string specId = "";
// Make the request
gcav::Spec response = apiHubClient.CreateSpec(parent, spec, specId);
CreateSpec(string, Spec, string, CallSettings)
public virtual Spec CreateSpec(string parent, Spec spec, string specId, CallSettings callSettings = null)
Add a spec to an API version in the API hub.
Multiple specs can be added to an API version.
Note, while adding a spec, at least one of contents
or source_uri
must
be provided. If contents
is provided, then spec_type
must also be
provided.
On adding a spec with contents to the version, the operations present in it
will be added to the version.Note that the file contents in the spec should
be of the same type as defined in the
projects/{project}/locations/{location}/attributes/system-spec-type
attribute associated with spec resource. Note that specs of various types
can be uploaded, however parsing of details is supported for OpenAPI spec
currently.
In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for Spec.
Format:
|
spec |
Spec Required. The spec to create. |
specId |
string Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
gcav::Spec spec = new gcav::Spec();
string specId = "";
// Make the request
gcav::Spec response = apiHubClient.CreateSpec(parent, spec, specId);
CreateSpecAsync(CreateSpecRequest, CallSettings)
public virtual Task<Spec> CreateSpecAsync(CreateSpecRequest request, CallSettings callSettings = null)
Add a spec to an API version in the API hub.
Multiple specs can be added to an API version.
Note, while adding a spec, at least one of contents
or source_uri
must
be provided. If contents
is provided, then spec_type
must also be
provided.
On adding a spec with contents to the version, the operations present in it
will be added to the version.Note that the file contents in the spec should
be of the same type as defined in the
projects/{project}/locations/{location}/attributes/system-spec-type
attribute associated with spec resource. Note that specs of various types
can be uploaded, however parsing of details is supported for OpenAPI spec
currently.
In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
Parameters | |
---|---|
Name | Description |
request |
CreateSpecRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateSpecRequest request = new gcav::CreateSpecRequest
{
ParentAsVersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
SpecId = "",
Spec = new gcav::Spec(),
};
// Make the request
gcav::Spec response = await apiHubClient.CreateSpecAsync(request);
CreateSpecAsync(CreateSpecRequest, CancellationToken)
public virtual Task<Spec> CreateSpecAsync(CreateSpecRequest request, CancellationToken cancellationToken)
Add a spec to an API version in the API hub.
Multiple specs can be added to an API version.
Note, while adding a spec, at least one of contents
or source_uri
must
be provided. If contents
is provided, then spec_type
must also be
provided.
On adding a spec with contents to the version, the operations present in it
will be added to the version.Note that the file contents in the spec should
be of the same type as defined in the
projects/{project}/locations/{location}/attributes/system-spec-type
attribute associated with spec resource. Note that specs of various types
can be uploaded, however parsing of details is supported for OpenAPI spec
currently.
In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
Parameters | |
---|---|
Name | Description |
request |
CreateSpecRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateSpecRequest request = new gcav::CreateSpecRequest
{
ParentAsVersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
SpecId = "",
Spec = new gcav::Spec(),
};
// Make the request
gcav::Spec response = await apiHubClient.CreateSpecAsync(request);
CreateSpecAsync(VersionName, Spec, string, CallSettings)
public virtual Task<Spec> CreateSpecAsync(VersionName parent, Spec spec, string specId, CallSettings callSettings = null)
Add a spec to an API version in the API hub.
Multiple specs can be added to an API version.
Note, while adding a spec, at least one of contents
or source_uri
must
be provided. If contents
is provided, then spec_type
must also be
provided.
On adding a spec with contents to the version, the operations present in it
will be added to the version.Note that the file contents in the spec should
be of the same type as defined in the
projects/{project}/locations/{location}/attributes/system-spec-type
attribute associated with spec resource. Note that specs of various types
can be uploaded, however parsing of details is supported for OpenAPI spec
currently.
In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
Parameters | |
---|---|
Name | Description |
parent |
VersionName Required. The parent resource for Spec.
Format:
|
spec |
Spec Required. The spec to create. |
specId |
string Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName parent = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
gcav::Spec spec = new gcav::Spec();
string specId = "";
// Make the request
gcav::Spec response = await apiHubClient.CreateSpecAsync(parent, spec, specId);
CreateSpecAsync(VersionName, Spec, string, CancellationToken)
public virtual Task<Spec> CreateSpecAsync(VersionName parent, Spec spec, string specId, CancellationToken cancellationToken)
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 |
parent |
VersionName Required. The parent resource for Spec.
Format:
|
spec |
Spec Required. The spec to create. |
specId |
string Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName parent = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
gcav::Spec spec = new gcav::Spec();
string specId = "";
// Make the request
gcav::Spec response = await apiHubClient.CreateSpecAsync(parent, spec, specId);
CreateSpecAsync(string, Spec, string, CallSettings)
public virtual Task<Spec> CreateSpecAsync(string parent, Spec spec, string specId, CallSettings callSettings = null)
Add a spec to an API version in the API hub.
Multiple specs can be added to an API version.
Note, while adding a spec, at least one of contents
or source_uri
must
be provided. If contents
is provided, then spec_type
must also be
provided.
On adding a spec with contents to the version, the operations present in it
will be added to the version.Note that the file contents in the spec should
be of the same type as defined in the
projects/{project}/locations/{location}/attributes/system-spec-type
attribute associated with spec resource. Note that specs of various types
can be uploaded, however parsing of details is supported for OpenAPI spec
currently.
In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for Spec.
Format:
|
spec |
Spec Required. The spec to create. |
specId |
string Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
gcav::Spec spec = new gcav::Spec();
string specId = "";
// Make the request
gcav::Spec response = await apiHubClient.CreateSpecAsync(parent, spec, specId);
CreateSpecAsync(string, Spec, string, CancellationToken)
public virtual Task<Spec> CreateSpecAsync(string parent, Spec spec, string specId, CancellationToken cancellationToken)
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 |
parent |
string Required. The parent resource for Spec.
Format:
|
spec |
Spec Required. The spec to create. |
specId |
string Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
gcav::Spec spec = new gcav::Spec();
string specId = "";
// Make the request
gcav::Spec response = await apiHubClient.CreateSpecAsync(parent, spec, specId);
CreateVersion(ApiName, Version, string, CallSettings)
public virtual Version CreateVersion(ApiName parent, Version version, string versionId, CallSettings callSettings = null)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
ApiName Required. The parent resource for API version.
Format: |
version |
Version Required. The version to create. |
versionId |
string Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ApiName parent = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
gcav::Version version = new gcav::Version();
string versionId = "";
// Make the request
gcav::Version response = apiHubClient.CreateVersion(parent, version, versionId);
CreateVersion(CreateVersionRequest, CallSettings)
public virtual Version CreateVersion(CreateVersionRequest request, CallSettings callSettings = null)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::CreateVersionRequest request = new gcav::CreateVersionRequest
{
ParentAsApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
VersionId = "",
Version = new gcav::Version(),
};
// Make the request
gcav::Version response = apiHubClient.CreateVersion(request);
CreateVersion(string, Version, string, CallSettings)
public virtual Version CreateVersion(string parent, Version version, string versionId, CallSettings callSettings = null)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for API version.
Format: |
version |
Version Required. The version to create. |
versionId |
string Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
gcav::Version version = new gcav::Version();
string versionId = "";
// Make the request
gcav::Version response = apiHubClient.CreateVersion(parent, version, versionId);
CreateVersionAsync(ApiName, Version, string, CallSettings)
public virtual Task<Version> CreateVersionAsync(ApiName parent, Version version, string versionId, CallSettings callSettings = null)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
ApiName Required. The parent resource for API version.
Format: |
version |
Version Required. The version to create. |
versionId |
string Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiName parent = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
gcav::Version version = new gcav::Version();
string versionId = "";
// Make the request
gcav::Version response = await apiHubClient.CreateVersionAsync(parent, version, versionId);
CreateVersionAsync(ApiName, Version, string, CancellationToken)
public virtual Task<Version> CreateVersionAsync(ApiName parent, Version version, string versionId, CancellationToken cancellationToken)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
ApiName Required. The parent resource for API version.
Format: |
version |
Version Required. The version to create. |
versionId |
string Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiName parent = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
gcav::Version version = new gcav::Version();
string versionId = "";
// Make the request
gcav::Version response = await apiHubClient.CreateVersionAsync(parent, version, versionId);
CreateVersionAsync(CreateVersionRequest, CallSettings)
public virtual Task<Version> CreateVersionAsync(CreateVersionRequest request, CallSettings callSettings = null)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateVersionRequest request = new gcav::CreateVersionRequest
{
ParentAsApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
VersionId = "",
Version = new gcav::Version(),
};
// Make the request
gcav::Version response = await apiHubClient.CreateVersionAsync(request);
CreateVersionAsync(CreateVersionRequest, CancellationToken)
public virtual Task<Version> CreateVersionAsync(CreateVersionRequest request, CancellationToken cancellationToken)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
CreateVersionRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateVersionRequest request = new gcav::CreateVersionRequest
{
ParentAsApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
VersionId = "",
Version = new gcav::Version(),
};
// Make the request
gcav::Version response = await apiHubClient.CreateVersionAsync(request);
CreateVersionAsync(string, Version, string, CallSettings)
public virtual Task<Version> CreateVersionAsync(string parent, Version version, string versionId, CallSettings callSettings = null)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for API version.
Format: |
version |
Version Required. The version to create. |
versionId |
string Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
gcav::Version version = new gcav::Version();
string versionId = "";
// Make the request
gcav::Version response = await apiHubClient.CreateVersionAsync(parent, version, versionId);
CreateVersionAsync(string, Version, string, CancellationToken)
public virtual Task<Version> CreateVersionAsync(string parent, Version version, string versionId, CancellationToken cancellationToken)
Create an API version for an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for API version.
Format: |
version |
Version Required. The version to create. |
versionId |
string Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
gcav::Version version = new gcav::Version();
string versionId = "";
// Make the request
gcav::Version response = await apiHubClient.CreateVersionAsync(parent, version, versionId);
DeleteApi(ApiName, CallSettings)
public virtual void DeleteApi(ApiName name, CallSettings callSettings = null)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
name |
ApiName Required. The name of the API resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ApiName name = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
apiHubClient.DeleteApi(name);
DeleteApi(DeleteApiRequest, CallSettings)
public virtual void DeleteApi(DeleteApiRequest request, CallSettings callSettings = null)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeleteApiRequest request = new gcav::DeleteApiRequest
{
ApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
Force = false,
};
// Make the request
apiHubClient.DeleteApi(request);
DeleteApi(string, CallSettings)
public virtual void DeleteApi(string name, CallSettings callSettings = null)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
apiHubClient.DeleteApi(name);
DeleteApiAsync(ApiName, CallSettings)
public virtual Task DeleteApiAsync(ApiName name, CallSettings callSettings = null)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
name |
ApiName Required. The name of the API resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiName name = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
await apiHubClient.DeleteApiAsync(name);
DeleteApiAsync(ApiName, CancellationToken)
public virtual Task DeleteApiAsync(ApiName name, CancellationToken cancellationToken)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
name |
ApiName Required. The name of the API resource to delete.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiName name = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
await apiHubClient.DeleteApiAsync(name);
DeleteApiAsync(DeleteApiRequest, CallSettings)
public virtual Task DeleteApiAsync(DeleteApiRequest request, CallSettings callSettings = null)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteApiRequest request = new gcav::DeleteApiRequest
{
ApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
Force = false,
};
// Make the request
await apiHubClient.DeleteApiAsync(request);
DeleteApiAsync(DeleteApiRequest, CancellationToken)
public virtual Task DeleteApiAsync(DeleteApiRequest request, CancellationToken cancellationToken)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteApiRequest request = new gcav::DeleteApiRequest
{
ApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
Force = false,
};
// Make the request
await apiHubClient.DeleteApiAsync(request);
DeleteApiAsync(string, CallSettings)
public virtual Task DeleteApiAsync(string name, CallSettings callSettings = null)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
await apiHubClient.DeleteApiAsync(name);
DeleteApiAsync(string, CancellationToken)
public virtual Task DeleteApiAsync(string name, CancellationToken cancellationToken)
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API resource to delete.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
await apiHubClient.DeleteApiAsync(name);
DeleteAttribute(AttributeName, CallSettings)
public virtual void DeleteAttribute(AttributeName name, CallSettings callSettings = null)
Delete an attribute.
Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
Parameters | |
---|---|
Name | Description |
name |
AttributeName Required. The name of the attribute to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::AttributeName name = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]");
// Make the request
apiHubClient.DeleteAttribute(name);
DeleteAttribute(DeleteAttributeRequest, CallSettings)
public virtual void DeleteAttribute(DeleteAttributeRequest request, CallSettings callSettings = null)
Delete an attribute.
Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeleteAttributeRequest request = new gcav::DeleteAttributeRequest
{
AttributeName = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]"),
};
// Make the request
apiHubClient.DeleteAttribute(request);
DeleteAttribute(string, CallSettings)
public virtual void DeleteAttribute(string name, CallSettings callSettings = null)
Delete an attribute.
Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the attribute to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attributes/[ATTRIBUTE]";
// Make the request
apiHubClient.DeleteAttribute(name);
DeleteAttributeAsync(AttributeName, CallSettings)
public virtual Task DeleteAttributeAsync(AttributeName name, CallSettings callSettings = null)
Delete an attribute.
Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
Parameters | |
---|---|
Name | Description |
name |
AttributeName Required. The name of the attribute to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::AttributeName name = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]");
// Make the request
await apiHubClient.DeleteAttributeAsync(name);
DeleteAttributeAsync(AttributeName, CancellationToken)
public virtual Task DeleteAttributeAsync(AttributeName name, CancellationToken cancellationToken)
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 |
name |
AttributeName Required. The name of the attribute to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::AttributeName name = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]");
// Make the request
await apiHubClient.DeleteAttributeAsync(name);
DeleteAttributeAsync(DeleteAttributeRequest, CallSettings)
public virtual Task DeleteAttributeAsync(DeleteAttributeRequest request, CallSettings callSettings = null)
Delete an attribute.
Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteAttributeRequest request = new gcav::DeleteAttributeRequest
{
AttributeName = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]"),
};
// Make the request
await apiHubClient.DeleteAttributeAsync(request);
DeleteAttributeAsync(DeleteAttributeRequest, CancellationToken)
public virtual Task DeleteAttributeAsync(DeleteAttributeRequest request, CancellationToken cancellationToken)
Delete an attribute.
Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteAttributeRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteAttributeRequest request = new gcav::DeleteAttributeRequest
{
AttributeName = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]"),
};
// Make the request
await apiHubClient.DeleteAttributeAsync(request);
DeleteAttributeAsync(string, CallSettings)
public virtual Task DeleteAttributeAsync(string name, CallSettings callSettings = null)
Delete an attribute.
Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the attribute to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attributes/[ATTRIBUTE]";
// Make the request
await apiHubClient.DeleteAttributeAsync(name);
DeleteAttributeAsync(string, CancellationToken)
public virtual Task DeleteAttributeAsync(string name, CancellationToken cancellationToken)
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 |
name |
string Required. The name of the attribute to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attributes/[ATTRIBUTE]";
// Make the request
await apiHubClient.DeleteAttributeAsync(name);
DeleteDeployment(DeleteDeploymentRequest, CallSettings)
public virtual void DeleteDeployment(DeleteDeploymentRequest request, CallSettings callSettings = null)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeleteDeploymentRequest request = new gcav::DeleteDeploymentRequest
{
DeploymentName = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
apiHubClient.DeleteDeployment(request);
DeleteDeployment(DeploymentName, CallSettings)
public virtual void DeleteDeployment(DeploymentName name, CallSettings callSettings = null)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
DeploymentName Required. The name of the deployment resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeploymentName name = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
apiHubClient.DeleteDeployment(name);
DeleteDeployment(string, CallSettings)
public virtual void DeleteDeployment(string name, CallSettings callSettings = null)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the deployment resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
apiHubClient.DeleteDeployment(name);
DeleteDeploymentAsync(DeleteDeploymentRequest, CallSettings)
public virtual Task DeleteDeploymentAsync(DeleteDeploymentRequest request, CallSettings callSettings = null)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteDeploymentRequest request = new gcav::DeleteDeploymentRequest
{
DeploymentName = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
await apiHubClient.DeleteDeploymentAsync(request);
DeleteDeploymentAsync(DeleteDeploymentRequest, CancellationToken)
public virtual Task DeleteDeploymentAsync(DeleteDeploymentRequest request, CancellationToken cancellationToken)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteDeploymentRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteDeploymentRequest request = new gcav::DeleteDeploymentRequest
{
DeploymentName = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
await apiHubClient.DeleteDeploymentAsync(request);
DeleteDeploymentAsync(DeploymentName, CallSettings)
public virtual Task DeleteDeploymentAsync(DeploymentName name, CallSettings callSettings = null)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
DeploymentName Required. The name of the deployment resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeploymentName name = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
await apiHubClient.DeleteDeploymentAsync(name);
DeleteDeploymentAsync(DeploymentName, CancellationToken)
public virtual Task DeleteDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
DeploymentName Required. The name of the deployment resource to delete.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeploymentName name = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
await apiHubClient.DeleteDeploymentAsync(name);
DeleteDeploymentAsync(string, CallSettings)
public virtual Task DeleteDeploymentAsync(string name, CallSettings callSettings = null)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the deployment resource to delete.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
await apiHubClient.DeleteDeploymentAsync(name);
DeleteDeploymentAsync(string, CancellationToken)
public virtual Task DeleteDeploymentAsync(string name, CancellationToken cancellationToken)
Delete a deployment resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the deployment resource to delete.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
await apiHubClient.DeleteDeploymentAsync(name);
DeleteExternalApi(DeleteExternalApiRequest, CallSettings)
public virtual void DeleteExternalApi(DeleteExternalApiRequest request, CallSettings callSettings = null)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeleteExternalApiRequest request = new gcav::DeleteExternalApiRequest
{
ExternalApiName = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]"),
};
// Make the request
apiHubClient.DeleteExternalApi(request);
DeleteExternalApi(ExternalApiName, CallSettings)
public virtual void DeleteExternalApi(ExternalApiName name, CallSettings callSettings = null)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
ExternalApiName Required. The name of the External API resource to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ExternalApiName name = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]");
// Make the request
apiHubClient.DeleteExternalApi(name);
DeleteExternalApi(string, CallSettings)
public virtual void DeleteExternalApi(string name, CallSettings callSettings = null)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the External API resource to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/externalApis/[EXTERNAL_API]";
// Make the request
apiHubClient.DeleteExternalApi(name);
DeleteExternalApiAsync(DeleteExternalApiRequest, CallSettings)
public virtual Task DeleteExternalApiAsync(DeleteExternalApiRequest request, CallSettings callSettings = null)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteExternalApiRequest request = new gcav::DeleteExternalApiRequest
{
ExternalApiName = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]"),
};
// Make the request
await apiHubClient.DeleteExternalApiAsync(request);
DeleteExternalApiAsync(DeleteExternalApiRequest, CancellationToken)
public virtual Task DeleteExternalApiAsync(DeleteExternalApiRequest request, CancellationToken cancellationToken)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
DeleteExternalApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteExternalApiRequest request = new gcav::DeleteExternalApiRequest
{
ExternalApiName = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]"),
};
// Make the request
await apiHubClient.DeleteExternalApiAsync(request);
DeleteExternalApiAsync(ExternalApiName, CallSettings)
public virtual Task DeleteExternalApiAsync(ExternalApiName name, CallSettings callSettings = null)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
ExternalApiName Required. The name of the External API resource to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ExternalApiName name = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]");
// Make the request
await apiHubClient.DeleteExternalApiAsync(name);
DeleteExternalApiAsync(ExternalApiName, CancellationToken)
public virtual Task DeleteExternalApiAsync(ExternalApiName name, CancellationToken cancellationToken)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
ExternalApiName Required. The name of the External API resource to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ExternalApiName name = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]");
// Make the request
await apiHubClient.DeleteExternalApiAsync(name);
DeleteExternalApiAsync(string, CallSettings)
public virtual Task DeleteExternalApiAsync(string name, CallSettings callSettings = null)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the External API resource to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/externalApis/[EXTERNAL_API]";
// Make the request
await apiHubClient.DeleteExternalApiAsync(name);
DeleteExternalApiAsync(string, CancellationToken)
public virtual Task DeleteExternalApiAsync(string name, CancellationToken cancellationToken)
Delete an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the External API resource to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/externalApis/[EXTERNAL_API]";
// Make the request
await apiHubClient.DeleteExternalApiAsync(name);
DeleteSpec(DeleteSpecRequest, CallSettings)
public virtual void DeleteSpec(DeleteSpecRequest request, CallSettings callSettings = null)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
request |
DeleteSpecRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeleteSpecRequest request = new gcav::DeleteSpecRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
apiHubClient.DeleteSpec(request);
DeleteSpec(SpecName, CallSettings)
public virtual void DeleteSpec(SpecName name, CallSettings callSettings = null)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
apiHubClient.DeleteSpec(name);
DeleteSpec(string, CallSettings)
public virtual void DeleteSpec(string name, CallSettings callSettings = null)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
apiHubClient.DeleteSpec(name);
DeleteSpecAsync(DeleteSpecRequest, CallSettings)
public virtual Task DeleteSpecAsync(DeleteSpecRequest request, CallSettings callSettings = null)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
request |
DeleteSpecRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteSpecRequest request = new gcav::DeleteSpecRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
await apiHubClient.DeleteSpecAsync(request);
DeleteSpecAsync(DeleteSpecRequest, CancellationToken)
public virtual Task DeleteSpecAsync(DeleteSpecRequest request, CancellationToken cancellationToken)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
request |
DeleteSpecRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteSpecRequest request = new gcav::DeleteSpecRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
await apiHubClient.DeleteSpecAsync(request);
DeleteSpecAsync(SpecName, CallSettings)
public virtual Task DeleteSpecAsync(SpecName name, CallSettings callSettings = null)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
await apiHubClient.DeleteSpecAsync(name);
DeleteSpecAsync(SpecName, CancellationToken)
public virtual Task DeleteSpecAsync(SpecName name, CancellationToken cancellationToken)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
await apiHubClient.DeleteSpecAsync(name);
DeleteSpecAsync(string, CallSettings)
public virtual Task DeleteSpecAsync(string name, CallSettings callSettings = null)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
await apiHubClient.DeleteSpecAsync(name);
DeleteSpecAsync(string, CancellationToken)
public virtual Task DeleteSpecAsync(string name, CancellationToken cancellationToken)
Delete a spec. Deleting a spec will also delete the associated operations from the version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
await apiHubClient.DeleteSpecAsync(name);
DeleteVersion(DeleteVersionRequest, CallSettings)
public virtual void DeleteVersion(DeleteVersionRequest request, CallSettings callSettings = null)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeleteVersionRequest request = new gcav::DeleteVersionRequest
{
VersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
Force = false,
};
// Make the request
apiHubClient.DeleteVersion(request);
DeleteVersion(VersionName, CallSettings)
public virtual void DeleteVersion(VersionName name, CallSettings callSettings = null)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
name |
VersionName Required. The name of the version to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::VersionName name = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
apiHubClient.DeleteVersion(name);
DeleteVersion(string, CallSettings)
public virtual void DeleteVersion(string name, CallSettings callSettings = null)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the version to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
apiHubClient.DeleteVersion(name);
DeleteVersionAsync(DeleteVersionRequest, CallSettings)
public virtual Task DeleteVersionAsync(DeleteVersionRequest request, CallSettings callSettings = null)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteVersionRequest request = new gcav::DeleteVersionRequest
{
VersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
Force = false,
};
// Make the request
await apiHubClient.DeleteVersionAsync(request);
DeleteVersionAsync(DeleteVersionRequest, CancellationToken)
public virtual Task DeleteVersionAsync(DeleteVersionRequest request, CancellationToken cancellationToken)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
request |
DeleteVersionRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteVersionRequest request = new gcav::DeleteVersionRequest
{
VersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
Force = false,
};
// Make the request
await apiHubClient.DeleteVersionAsync(request);
DeleteVersionAsync(VersionName, CallSettings)
public virtual Task DeleteVersionAsync(VersionName name, CallSettings callSettings = null)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
name |
VersionName Required. The name of the version to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName name = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
await apiHubClient.DeleteVersionAsync(name);
DeleteVersionAsync(VersionName, CancellationToken)
public virtual Task DeleteVersionAsync(VersionName name, CancellationToken cancellationToken)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
name |
VersionName Required. The name of the version to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName name = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
await apiHubClient.DeleteVersionAsync(name);
DeleteVersionAsync(string, CallSettings)
public virtual Task DeleteVersionAsync(string name, CallSettings callSettings = null)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the version to delete.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
await apiHubClient.DeleteVersionAsync(name);
DeleteVersionAsync(string, CancellationToken)
public virtual Task DeleteVersionAsync(string name, CancellationToken cancellationToken)
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the version to delete.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
await apiHubClient.DeleteVersionAsync(name);
GetApi(ApiName, CallSettings)
public virtual Api GetApi(ApiName name, CallSettings callSettings = null)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
name |
ApiName Required. The name of the API resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ApiName name = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
gcav::Api response = apiHubClient.GetApi(name);
GetApi(GetApiRequest, CallSettings)
public virtual Api GetApi(GetApiRequest request, CallSettings callSettings = null)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetApiRequest request = new gcav::GetApiRequest
{
ApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
};
// Make the request
gcav::Api response = apiHubClient.GetApi(request);
GetApi(string, CallSettings)
public virtual Api GetApi(string name, CallSettings callSettings = null)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
gcav::Api response = apiHubClient.GetApi(name);
GetApiAsync(ApiName, CallSettings)
public virtual Task<Api> GetApiAsync(ApiName name, CallSettings callSettings = null)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
name |
ApiName Required. The name of the API resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiName name = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
gcav::Api response = await apiHubClient.GetApiAsync(name);
GetApiAsync(ApiName, CancellationToken)
public virtual Task<Api> GetApiAsync(ApiName name, CancellationToken cancellationToken)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
name |
ApiName Required. The name of the API resource to retrieve.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiName name = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
gcav::Api response = await apiHubClient.GetApiAsync(name);
GetApiAsync(GetApiRequest, CallSettings)
public virtual Task<Api> GetApiAsync(GetApiRequest request, CallSettings callSettings = null)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetApiRequest request = new gcav::GetApiRequest
{
ApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
};
// Make the request
gcav::Api response = await apiHubClient.GetApiAsync(request);
GetApiAsync(GetApiRequest, CancellationToken)
public virtual Task<Api> GetApiAsync(GetApiRequest request, CancellationToken cancellationToken)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
request |
GetApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetApiRequest request = new gcav::GetApiRequest
{
ApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
};
// Make the request
gcav::Api response = await apiHubClient.GetApiAsync(request);
GetApiAsync(string, CallSettings)
public virtual Task<Api> GetApiAsync(string name, CallSettings callSettings = null)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
gcav::Api response = await apiHubClient.GetApiAsync(name);
GetApiAsync(string, CancellationToken)
public virtual Task<Api> GetApiAsync(string name, CancellationToken cancellationToken)
Get API resource details including the API versions contained in it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API resource to retrieve.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
gcav::Api response = await apiHubClient.GetApiAsync(name);
GetApiOperation(ApiOperationName, CallSettings)
public virtual ApiOperation GetApiOperation(ApiOperationName name, CallSettings callSettings = null)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
name |
ApiOperationName Required. The name of the operation to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ApiOperation |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ApiOperationName name = gcav::ApiOperationName.FromProjectLocationApiVersionOperation("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[OPERATION]");
// Make the request
gcav::ApiOperation response = apiHubClient.GetApiOperation(name);
GetApiOperation(GetApiOperationRequest, CallSettings)
public virtual ApiOperation GetApiOperation(GetApiOperationRequest request, CallSettings callSettings = null)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
request |
GetApiOperationRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ApiOperation |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetApiOperationRequest request = new gcav::GetApiOperationRequest
{
ApiOperationName = gcav::ApiOperationName.FromProjectLocationApiVersionOperation("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[OPERATION]"),
};
// Make the request
gcav::ApiOperation response = apiHubClient.GetApiOperation(request);
GetApiOperation(string, CallSettings)
public virtual ApiOperation GetApiOperation(string name, CallSettings callSettings = null)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the operation to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ApiOperation |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/operations/[OPERATION]";
// Make the request
gcav::ApiOperation response = apiHubClient.GetApiOperation(name);
GetApiOperationAsync(ApiOperationName, CallSettings)
public virtual Task<ApiOperation> GetApiOperationAsync(ApiOperationName name, CallSettings callSettings = null)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
name |
ApiOperationName Required. The name of the operation to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApiOperation |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiOperationName name = gcav::ApiOperationName.FromProjectLocationApiVersionOperation("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[OPERATION]");
// Make the request
gcav::ApiOperation response = await apiHubClient.GetApiOperationAsync(name);
GetApiOperationAsync(ApiOperationName, CancellationToken)
public virtual Task<ApiOperation> GetApiOperationAsync(ApiOperationName name, CancellationToken cancellationToken)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
name |
ApiOperationName Required. The name of the operation to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApiOperation |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiOperationName name = gcav::ApiOperationName.FromProjectLocationApiVersionOperation("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[OPERATION]");
// Make the request
gcav::ApiOperation response = await apiHubClient.GetApiOperationAsync(name);
GetApiOperationAsync(GetApiOperationRequest, CallSettings)
public virtual Task<ApiOperation> GetApiOperationAsync(GetApiOperationRequest request, CallSettings callSettings = null)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
request |
GetApiOperationRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApiOperation |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetApiOperationRequest request = new gcav::GetApiOperationRequest
{
ApiOperationName = gcav::ApiOperationName.FromProjectLocationApiVersionOperation("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[OPERATION]"),
};
// Make the request
gcav::ApiOperation response = await apiHubClient.GetApiOperationAsync(request);
GetApiOperationAsync(GetApiOperationRequest, CancellationToken)
public virtual Task<ApiOperation> GetApiOperationAsync(GetApiOperationRequest request, CancellationToken cancellationToken)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
request |
GetApiOperationRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApiOperation |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetApiOperationRequest request = new gcav::GetApiOperationRequest
{
ApiOperationName = gcav::ApiOperationName.FromProjectLocationApiVersionOperation("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[OPERATION]"),
};
// Make the request
gcav::ApiOperation response = await apiHubClient.GetApiOperationAsync(request);
GetApiOperationAsync(string, CallSettings)
public virtual Task<ApiOperation> GetApiOperationAsync(string name, CallSettings callSettings = null)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the operation to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApiOperation |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/operations/[OPERATION]";
// Make the request
gcav::ApiOperation response = await apiHubClient.GetApiOperationAsync(name);
GetApiOperationAsync(string, CancellationToken)
public virtual Task<ApiOperation> GetApiOperationAsync(string name, CancellationToken cancellationToken)
Get details about a particular operation in API version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the operation to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApiOperation |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/operations/[OPERATION]";
// Make the request
gcav::ApiOperation response = await apiHubClient.GetApiOperationAsync(name);
GetAttribute(AttributeName, CallSettings)
public virtual Attribute GetAttribute(AttributeName name, CallSettings callSettings = null)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
name |
AttributeName Required. The name of the attribute to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::AttributeName name = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]");
// Make the request
gcav::Attribute response = apiHubClient.GetAttribute(name);
GetAttribute(GetAttributeRequest, CallSettings)
public virtual Attribute GetAttribute(GetAttributeRequest request, CallSettings callSettings = null)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
request |
GetAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetAttributeRequest request = new gcav::GetAttributeRequest
{
AttributeName = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]"),
};
// Make the request
gcav::Attribute response = apiHubClient.GetAttribute(request);
GetAttribute(string, CallSettings)
public virtual Attribute GetAttribute(string name, CallSettings callSettings = null)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the attribute to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attributes/[ATTRIBUTE]";
// Make the request
gcav::Attribute response = apiHubClient.GetAttribute(name);
GetAttributeAsync(AttributeName, CallSettings)
public virtual Task<Attribute> GetAttributeAsync(AttributeName name, CallSettings callSettings = null)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
name |
AttributeName Required. The name of the attribute to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::AttributeName name = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]");
// Make the request
gcav::Attribute response = await apiHubClient.GetAttributeAsync(name);
GetAttributeAsync(AttributeName, CancellationToken)
public virtual Task<Attribute> GetAttributeAsync(AttributeName name, CancellationToken cancellationToken)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
name |
AttributeName Required. The name of the attribute to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::AttributeName name = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]");
// Make the request
gcav::Attribute response = await apiHubClient.GetAttributeAsync(name);
GetAttributeAsync(GetAttributeRequest, CallSettings)
public virtual Task<Attribute> GetAttributeAsync(GetAttributeRequest request, CallSettings callSettings = null)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
request |
GetAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetAttributeRequest request = new gcav::GetAttributeRequest
{
AttributeName = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]"),
};
// Make the request
gcav::Attribute response = await apiHubClient.GetAttributeAsync(request);
GetAttributeAsync(GetAttributeRequest, CancellationToken)
public virtual Task<Attribute> GetAttributeAsync(GetAttributeRequest request, CancellationToken cancellationToken)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
request |
GetAttributeRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetAttributeRequest request = new gcav::GetAttributeRequest
{
AttributeName = gcav::AttributeName.FromProjectLocationAttribute("[PROJECT]", "[LOCATION]", "[ATTRIBUTE]"),
};
// Make the request
gcav::Attribute response = await apiHubClient.GetAttributeAsync(request);
GetAttributeAsync(string, CallSettings)
public virtual Task<Attribute> GetAttributeAsync(string name, CallSettings callSettings = null)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the attribute to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attributes/[ATTRIBUTE]";
// Make the request
gcav::Attribute response = await apiHubClient.GetAttributeAsync(name);
GetAttributeAsync(string, CancellationToken)
public virtual Task<Attribute> GetAttributeAsync(string name, CancellationToken cancellationToken)
Get details about the attribute.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the attribute to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attributes/[ATTRIBUTE]";
// Make the request
gcav::Attribute response = await apiHubClient.GetAttributeAsync(name);
GetDefinition(DefinitionName, CallSettings)
public virtual Definition GetDefinition(DefinitionName name, CallSettings callSettings = null)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
name |
DefinitionName Required. The name of the definition to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Definition |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DefinitionName name = gcav::DefinitionName.FromProjectLocationApiVersionDefinition("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[DEFINITION]");
// Make the request
gcav::Definition response = apiHubClient.GetDefinition(name);
GetDefinition(GetDefinitionRequest, CallSettings)
public virtual Definition GetDefinition(GetDefinitionRequest request, CallSettings callSettings = null)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
request |
GetDefinitionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Definition |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetDefinitionRequest request = new gcav::GetDefinitionRequest
{
DefinitionName = gcav::DefinitionName.FromProjectLocationApiVersionDefinition("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[DEFINITION]"),
};
// Make the request
gcav::Definition response = apiHubClient.GetDefinition(request);
GetDefinition(string, CallSettings)
public virtual Definition GetDefinition(string name, CallSettings callSettings = null)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the definition to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Definition |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/definitions/[DEFINITION]";
// Make the request
gcav::Definition response = apiHubClient.GetDefinition(name);
GetDefinitionAsync(DefinitionName, CallSettings)
public virtual Task<Definition> GetDefinitionAsync(DefinitionName name, CallSettings callSettings = null)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
name |
DefinitionName Required. The name of the definition to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDefinition |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DefinitionName name = gcav::DefinitionName.FromProjectLocationApiVersionDefinition("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[DEFINITION]");
// Make the request
gcav::Definition response = await apiHubClient.GetDefinitionAsync(name);
GetDefinitionAsync(DefinitionName, CancellationToken)
public virtual Task<Definition> GetDefinitionAsync(DefinitionName name, CancellationToken cancellationToken)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
name |
DefinitionName Required. The name of the definition to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDefinition |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DefinitionName name = gcav::DefinitionName.FromProjectLocationApiVersionDefinition("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[DEFINITION]");
// Make the request
gcav::Definition response = await apiHubClient.GetDefinitionAsync(name);
GetDefinitionAsync(GetDefinitionRequest, CallSettings)
public virtual Task<Definition> GetDefinitionAsync(GetDefinitionRequest request, CallSettings callSettings = null)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
request |
GetDefinitionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDefinition |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetDefinitionRequest request = new gcav::GetDefinitionRequest
{
DefinitionName = gcav::DefinitionName.FromProjectLocationApiVersionDefinition("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[DEFINITION]"),
};
// Make the request
gcav::Definition response = await apiHubClient.GetDefinitionAsync(request);
GetDefinitionAsync(GetDefinitionRequest, CancellationToken)
public virtual Task<Definition> GetDefinitionAsync(GetDefinitionRequest request, CancellationToken cancellationToken)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
request |
GetDefinitionRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDefinition |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetDefinitionRequest request = new gcav::GetDefinitionRequest
{
DefinitionName = gcav::DefinitionName.FromProjectLocationApiVersionDefinition("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[DEFINITION]"),
};
// Make the request
gcav::Definition response = await apiHubClient.GetDefinitionAsync(request);
GetDefinitionAsync(string, CallSettings)
public virtual Task<Definition> GetDefinitionAsync(string name, CallSettings callSettings = null)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the definition to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDefinition |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/definitions/[DEFINITION]";
// Make the request
gcav::Definition response = await apiHubClient.GetDefinitionAsync(name);
GetDefinitionAsync(string, CancellationToken)
public virtual Task<Definition> GetDefinitionAsync(string name, CancellationToken cancellationToken)
Get details about a definition in an API version.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the definition to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDefinition |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/definitions/[DEFINITION]";
// Make the request
gcav::Definition response = await apiHubClient.GetDefinitionAsync(name);
GetDeployment(DeploymentName, CallSettings)
public virtual Deployment GetDeployment(DeploymentName name, CallSettings callSettings = null)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
name |
DeploymentName Required. The name of the deployment resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::DeploymentName name = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
gcav::Deployment response = apiHubClient.GetDeployment(name);
GetDeployment(GetDeploymentRequest, CallSettings)
public virtual Deployment GetDeployment(GetDeploymentRequest request, CallSettings callSettings = null)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetDeploymentRequest request = new gcav::GetDeploymentRequest
{
DeploymentName = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
gcav::Deployment response = apiHubClient.GetDeployment(request);
GetDeployment(string, CallSettings)
public virtual Deployment GetDeployment(string name, CallSettings callSettings = null)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the deployment resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
gcav::Deployment response = apiHubClient.GetDeployment(name);
GetDeploymentAsync(DeploymentName, CallSettings)
public virtual Task<Deployment> GetDeploymentAsync(DeploymentName name, CallSettings callSettings = null)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
name |
DeploymentName Required. The name of the deployment resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeploymentName name = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
gcav::Deployment response = await apiHubClient.GetDeploymentAsync(name);
GetDeploymentAsync(DeploymentName, CancellationToken)
public virtual Task<Deployment> GetDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
name |
DeploymentName Required. The name of the deployment resource to retrieve.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::DeploymentName name = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
gcav::Deployment response = await apiHubClient.GetDeploymentAsync(name);
GetDeploymentAsync(GetDeploymentRequest, CallSettings)
public virtual Task<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CallSettings callSettings = null)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetDeploymentRequest request = new gcav::GetDeploymentRequest
{
DeploymentName = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
gcav::Deployment response = await apiHubClient.GetDeploymentAsync(request);
GetDeploymentAsync(GetDeploymentRequest, CancellationToken)
public virtual Task<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CancellationToken cancellationToken)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetDeploymentRequest request = new gcav::GetDeploymentRequest
{
DeploymentName = gcav::DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
gcav::Deployment response = await apiHubClient.GetDeploymentAsync(request);
GetDeploymentAsync(string, CallSettings)
public virtual Task<Deployment> GetDeploymentAsync(string name, CallSettings callSettings = null)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the deployment resource to retrieve.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
gcav::Deployment response = await apiHubClient.GetDeploymentAsync(name);
GetDeploymentAsync(string, CancellationToken)
public virtual Task<Deployment> GetDeploymentAsync(string name, CancellationToken cancellationToken)
Get details about a deployment and the API versions linked to it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the deployment resource to retrieve.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
gcav::Deployment response = await apiHubClient.GetDeploymentAsync(name);
GetExternalApi(ExternalApiName, CallSettings)
public virtual ExternalApi GetExternalApi(ExternalApiName name, CallSettings callSettings = null)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
ExternalApiName Required. The name of the External API resource to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ExternalApiName name = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]");
// Make the request
gcav::ExternalApi response = apiHubClient.GetExternalApi(name);
GetExternalApi(GetExternalApiRequest, CallSettings)
public virtual ExternalApi GetExternalApi(GetExternalApiRequest request, CallSettings callSettings = null)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
GetExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetExternalApiRequest request = new gcav::GetExternalApiRequest
{
ExternalApiName = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]"),
};
// Make the request
gcav::ExternalApi response = apiHubClient.GetExternalApi(request);
GetExternalApi(string, CallSettings)
public virtual ExternalApi GetExternalApi(string name, CallSettings callSettings = null)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the External API resource to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/externalApis/[EXTERNAL_API]";
// Make the request
gcav::ExternalApi response = apiHubClient.GetExternalApi(name);
GetExternalApiAsync(ExternalApiName, CallSettings)
public virtual Task<ExternalApi> GetExternalApiAsync(ExternalApiName name, CallSettings callSettings = null)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
ExternalApiName Required. The name of the External API resource to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ExternalApiName name = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]");
// Make the request
gcav::ExternalApi response = await apiHubClient.GetExternalApiAsync(name);
GetExternalApiAsync(ExternalApiName, CancellationToken)
public virtual Task<ExternalApi> GetExternalApiAsync(ExternalApiName name, CancellationToken cancellationToken)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
ExternalApiName Required. The name of the External API resource to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ExternalApiName name = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]");
// Make the request
gcav::ExternalApi response = await apiHubClient.GetExternalApiAsync(name);
GetExternalApiAsync(GetExternalApiRequest, CallSettings)
public virtual Task<ExternalApi> GetExternalApiAsync(GetExternalApiRequest request, CallSettings callSettings = null)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
GetExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetExternalApiRequest request = new gcav::GetExternalApiRequest
{
ExternalApiName = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]"),
};
// Make the request
gcav::ExternalApi response = await apiHubClient.GetExternalApiAsync(request);
GetExternalApiAsync(GetExternalApiRequest, CancellationToken)
public virtual Task<ExternalApi> GetExternalApiAsync(GetExternalApiRequest request, CancellationToken cancellationToken)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
GetExternalApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetExternalApiRequest request = new gcav::GetExternalApiRequest
{
ExternalApiName = gcav::ExternalApiName.FromProjectLocationExternalApi("[PROJECT]", "[LOCATION]", "[EXTERNAL_API]"),
};
// Make the request
gcav::ExternalApi response = await apiHubClient.GetExternalApiAsync(request);
GetExternalApiAsync(string, CallSettings)
public virtual Task<ExternalApi> GetExternalApiAsync(string name, CallSettings callSettings = null)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the External API resource to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/externalApis/[EXTERNAL_API]";
// Make the request
gcav::ExternalApi response = await apiHubClient.GetExternalApiAsync(name);
GetExternalApiAsync(string, CancellationToken)
public virtual Task<ExternalApi> GetExternalApiAsync(string name, CancellationToken cancellationToken)
Get details about an External API resource in the API hub.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the External API resource to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/externalApis/[EXTERNAL_API]";
// Make the request
gcav::ExternalApi response = await apiHubClient.GetExternalApiAsync(name);
GetSpec(GetSpecRequest, CallSettings)
public virtual Spec GetSpec(GetSpecRequest request, CallSettings callSettings = null)
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
Parameters | |
---|---|
Name | Description |
request |
GetSpecRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetSpecRequest request = new gcav::GetSpecRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
gcav::Spec response = apiHubClient.GetSpec(request);
GetSpec(SpecName, CallSettings)
public virtual Spec GetSpec(SpecName name, CallSettings callSettings = null)
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
gcav::Spec response = apiHubClient.GetSpec(name);
GetSpec(string, CallSettings)
public virtual Spec GetSpec(string name, CallSettings callSettings = null)
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
gcav::Spec response = apiHubClient.GetSpec(name);
GetSpecAsync(GetSpecRequest, CallSettings)
public virtual Task<Spec> GetSpecAsync(GetSpecRequest request, CallSettings callSettings = null)
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
Parameters | |
---|---|
Name | Description |
request |
GetSpecRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetSpecRequest request = new gcav::GetSpecRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
gcav::Spec response = await apiHubClient.GetSpecAsync(request);
GetSpecAsync(GetSpecRequest, CancellationToken)
public virtual Task<Spec> GetSpecAsync(GetSpecRequest request, CancellationToken cancellationToken)
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
Parameters | |
---|---|
Name | Description |
request |
GetSpecRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetSpecRequest request = new gcav::GetSpecRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
gcav::Spec response = await apiHubClient.GetSpecAsync(request);
GetSpecAsync(SpecName, CallSettings)
public virtual Task<Spec> GetSpecAsync(SpecName name, CallSettings callSettings = null)
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
gcav::Spec response = await apiHubClient.GetSpecAsync(name);
GetSpecAsync(SpecName, CancellationToken)
public virtual Task<Spec> GetSpecAsync(SpecName name, CancellationToken cancellationToken)
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 |
name |
SpecName Required. The name of the spec to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
gcav::Spec response = await apiHubClient.GetSpecAsync(name);
GetSpecAsync(string, CallSettings)
public virtual Task<Spec> GetSpecAsync(string name, CallSettings callSettings = null)
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
gcav::Spec response = await apiHubClient.GetSpecAsync(name);
GetSpecAsync(string, CancellationToken)
public virtual Task<Spec> GetSpecAsync(string name, CancellationToken cancellationToken)
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 |
name |
string Required. The name of the spec to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
gcav::Spec response = await apiHubClient.GetSpecAsync(name);
GetSpecContents(GetSpecContentsRequest, CallSettings)
public virtual SpecContents GetSpecContents(GetSpecContentsRequest request, CallSettings callSettings = null)
Get spec contents.
Parameters | |
---|---|
Name | Description |
request |
GetSpecContentsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SpecContents |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetSpecContentsRequest request = new gcav::GetSpecContentsRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
gcav::SpecContents response = apiHubClient.GetSpecContents(request);
GetSpecContents(SpecName, CallSettings)
public virtual SpecContents GetSpecContents(SpecName name, CallSettings callSettings = null)
Get spec contents.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec whose contents need to be retrieved.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SpecContents |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
gcav::SpecContents response = apiHubClient.GetSpecContents(name);
GetSpecContents(string, CallSettings)
public virtual SpecContents GetSpecContents(string name, CallSettings callSettings = null)
Get spec contents.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec whose contents need to be retrieved.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SpecContents |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
gcav::SpecContents response = apiHubClient.GetSpecContents(name);
GetSpecContentsAsync(GetSpecContentsRequest, CallSettings)
public virtual Task<SpecContents> GetSpecContentsAsync(GetSpecContentsRequest request, CallSettings callSettings = null)
Get spec contents.
Parameters | |
---|---|
Name | Description |
request |
GetSpecContentsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpecContents |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetSpecContentsRequest request = new gcav::GetSpecContentsRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
gcav::SpecContents response = await apiHubClient.GetSpecContentsAsync(request);
GetSpecContentsAsync(GetSpecContentsRequest, CancellationToken)
public virtual Task<SpecContents> GetSpecContentsAsync(GetSpecContentsRequest request, CancellationToken cancellationToken)
Get spec contents.
Parameters | |
---|---|
Name | Description |
request |
GetSpecContentsRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpecContents |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetSpecContentsRequest request = new gcav::GetSpecContentsRequest
{
SpecName = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]"),
};
// Make the request
gcav::SpecContents response = await apiHubClient.GetSpecContentsAsync(request);
GetSpecContentsAsync(SpecName, CallSettings)
public virtual Task<SpecContents> GetSpecContentsAsync(SpecName name, CallSettings callSettings = null)
Get spec contents.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec whose contents need to be retrieved.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpecContents |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
gcav::SpecContents response = await apiHubClient.GetSpecContentsAsync(name);
GetSpecContentsAsync(SpecName, CancellationToken)
public virtual Task<SpecContents> GetSpecContentsAsync(SpecName name, CancellationToken cancellationToken)
Get spec contents.
Parameters | |
---|---|
Name | Description |
name |
SpecName Required. The name of the spec whose contents need to be retrieved.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpecContents |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::SpecName name = gcav::SpecName.FromProjectLocationApiVersionSpec("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
// Make the request
gcav::SpecContents response = await apiHubClient.GetSpecContentsAsync(name);
GetSpecContentsAsync(string, CallSettings)
public virtual Task<SpecContents> GetSpecContentsAsync(string name, CallSettings callSettings = null)
Get spec contents.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec whose contents need to be retrieved.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpecContents |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
gcav::SpecContents response = await apiHubClient.GetSpecContentsAsync(name);
GetSpecContentsAsync(string, CancellationToken)
public virtual Task<SpecContents> GetSpecContentsAsync(string name, CancellationToken cancellationToken)
Get spec contents.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the spec whose contents need to be retrieved.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpecContents |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]/specs/[SPEC]";
// Make the request
gcav::SpecContents response = await apiHubClient.GetSpecContentsAsync(name);
GetVersion(GetVersionRequest, CallSettings)
public virtual Version GetVersion(GetVersionRequest request, CallSettings callSettings = null)
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::GetVersionRequest request = new gcav::GetVersionRequest
{
VersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
};
// Make the request
gcav::Version response = apiHubClient.GetVersion(request);
GetVersion(VersionName, CallSettings)
public virtual Version GetVersion(VersionName name, CallSettings callSettings = null)
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
Parameters | |
---|---|
Name | Description |
name |
VersionName Required. The name of the API version to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::VersionName name = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
gcav::Version response = apiHubClient.GetVersion(name);
GetVersion(string, CallSettings)
public virtual Version GetVersion(string name, CallSettings callSettings = null)
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API version to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
gcav::Version response = apiHubClient.GetVersion(name);
GetVersionAsync(GetVersionRequest, CallSettings)
public virtual Task<Version> GetVersionAsync(GetVersionRequest request, CallSettings callSettings = null)
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetVersionRequest request = new gcav::GetVersionRequest
{
VersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
};
// Make the request
gcav::Version response = await apiHubClient.GetVersionAsync(request);
GetVersionAsync(GetVersionRequest, CancellationToken)
public virtual Task<Version> GetVersionAsync(GetVersionRequest request, CancellationToken cancellationToken)
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
Parameters | |
---|---|
Name | Description |
request |
GetVersionRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::GetVersionRequest request = new gcav::GetVersionRequest
{
VersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
};
// Make the request
gcav::Version response = await apiHubClient.GetVersionAsync(request);
GetVersionAsync(VersionName, CallSettings)
public virtual Task<Version> GetVersionAsync(VersionName name, CallSettings callSettings = null)
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
Parameters | |
---|---|
Name | Description |
name |
VersionName Required. The name of the API version to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName name = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
gcav::Version response = await apiHubClient.GetVersionAsync(name);
GetVersionAsync(VersionName, CancellationToken)
public virtual Task<Version> GetVersionAsync(VersionName name, CancellationToken cancellationToken)
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 |
name |
VersionName Required. The name of the API version to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName name = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
gcav::Version response = await apiHubClient.GetVersionAsync(name);
GetVersionAsync(string, CallSettings)
public virtual Task<Version> GetVersionAsync(string name, CallSettings callSettings = null)
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the API version to retrieve.
Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
gcav::Version response = await apiHubClient.GetVersionAsync(name);
GetVersionAsync(string, CancellationToken)
public virtual Task<Version> GetVersionAsync(string name, CancellationToken cancellationToken)
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 |
name |
string Required. The name of the API version to retrieve.
Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
gcav::Version response = await apiHubClient.GetVersionAsync(name);
ListApiOperations(ListApiOperationsRequest, CallSettings)
public virtual PagedEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperations(ListApiOperationsRequest request, CallSettings callSettings = null)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
request |
ListApiOperationsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListApiOperationsResponseApiOperation |
A pageable sequence of ApiOperation resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ListApiOperationsRequest request = new gcav::ListApiOperationsRequest
{
ParentAsVersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
Filter = "",
};
// Make the request
PagedEnumerable<gcav::ListApiOperationsResponse, gcav::ApiOperation> response = apiHubClient.ListApiOperations(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::ApiOperation item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListApiOperationsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ApiOperation item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ApiOperation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ApiOperation item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApiOperations(VersionName, string, int?, CallSettings)
public virtual PagedEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperations(VersionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
parent |
VersionName Required. The parent which owns this collection of operations i.e., the API
version. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListApiOperationsResponseApiOperation |
A pageable sequence of ApiOperation resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::VersionName parent = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
PagedEnumerable<gcav::ListApiOperationsResponse, gcav::ApiOperation> response = apiHubClient.ListApiOperations(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::ApiOperation item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListApiOperationsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ApiOperation item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ApiOperation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ApiOperation item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApiOperations(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperations(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent which owns this collection of operations i.e., the API
version. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListApiOperationsResponseApiOperation |
A pageable sequence of ApiOperation resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
PagedEnumerable<gcav::ListApiOperationsResponse, gcav::ApiOperation> response = apiHubClient.ListApiOperations(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::ApiOperation item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListApiOperationsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ApiOperation item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ApiOperation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ApiOperation item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApiOperationsAsync(ListApiOperationsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperationsAsync(ListApiOperationsRequest request, CallSettings callSettings = null)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
request |
ListApiOperationsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListApiOperationsResponseApiOperation |
A pageable asynchronous sequence of ApiOperation resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ListApiOperationsRequest request = new gcav::ListApiOperationsRequest
{
ParentAsVersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<gcav::ListApiOperationsResponse, gcav::ApiOperation> response = apiHubClient.ListApiOperationsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::ApiOperation item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListApiOperationsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ApiOperation item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ApiOperation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ApiOperation item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApiOperationsAsync(VersionName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperationsAsync(VersionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
parent |
VersionName Required. The parent which owns this collection of operations i.e., the API
version. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListApiOperationsResponseApiOperation |
A pageable asynchronous sequence of ApiOperation resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName parent = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
PagedAsyncEnumerable<gcav::ListApiOperationsResponse, gcav::ApiOperation> response = apiHubClient.ListApiOperationsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::ApiOperation item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListApiOperationsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ApiOperation item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ApiOperation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ApiOperation item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApiOperationsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListApiOperationsResponse, ApiOperation> ListApiOperationsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List operations in an API version.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent which owns this collection of operations i.e., the API
version. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListApiOperationsResponseApiOperation |
A pageable asynchronous sequence of ApiOperation resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
PagedAsyncEnumerable<gcav::ListApiOperationsResponse, gcav::ApiOperation> response = apiHubClient.ListApiOperationsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::ApiOperation item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListApiOperationsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ApiOperation item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ApiOperation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ApiOperation item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApis(LocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListApisResponse, Api> ListApis(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent, which owns this collection of API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListApisResponseApi |
A pageable sequence of Api resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<gcav::ListApisResponse, gcav::Api> response = apiHubClient.ListApis(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Api item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListApisResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Api item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Api> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Api item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApis(ListApisRequest, CallSettings)
public virtual PagedEnumerable<ListApisResponse, Api> ListApis(ListApisRequest request, CallSettings callSettings = null)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListApisRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListApisResponseApi |
A pageable sequence of Api resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ListApisRequest request = new gcav::ListApisRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
};
// Make the request
PagedEnumerable<gcav::ListApisResponse, gcav::Api> response = apiHubClient.ListApis(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Api item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListApisResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Api item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Api> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Api item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApis(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListApisResponse, Api> ListApis(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListApisResponseApi |
A pageable sequence of Api resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<gcav::ListApisResponse, gcav::Api> response = apiHubClient.ListApis(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Api item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListApisResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Api item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Api> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Api item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApisAsync(LocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent, which owns this collection of API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListApisResponseApi |
A pageable asynchronous sequence of Api resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<gcav::ListApisResponse, gcav::Api> response = apiHubClient.ListApisAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Api item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListApisResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Api item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Api> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Api item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApisAsync(ListApisRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(ListApisRequest request, CallSettings callSettings = null)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListApisRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListApisResponseApi |
A pageable asynchronous sequence of Api resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ListApisRequest request = new gcav::ListApisRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<gcav::ListApisResponse, gcav::Api> response = apiHubClient.ListApisAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Api item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListApisResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Api item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Api> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Api item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListApisAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListApisResponseApi |
A pageable asynchronous sequence of Api resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<gcav::ListApisResponse, gcav::Api> response = apiHubClient.ListApisAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Api item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListApisResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Api item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Api> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Api item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAttributes(LocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListAttributesResponse, Attribute> ListAttributes(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List all attributes.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for Attribute.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListAttributesResponseAttribute |
A pageable sequence of Attribute resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<gcav::ListAttributesResponse, gcav::Attribute> response = apiHubClient.ListAttributes(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Attribute item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListAttributesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Attribute item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Attribute> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Attribute item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAttributes(ListAttributesRequest, CallSettings)
public virtual PagedEnumerable<ListAttributesResponse, Attribute> ListAttributes(ListAttributesRequest request, CallSettings callSettings = null)
List all attributes.
Parameters | |
---|---|
Name | Description |
request |
ListAttributesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListAttributesResponseAttribute |
A pageable sequence of Attribute resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ListAttributesRequest request = new gcav::ListAttributesRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
};
// Make the request
PagedEnumerable<gcav::ListAttributesResponse, gcav::Attribute> response = apiHubClient.ListAttributes(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Attribute item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListAttributesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Attribute item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Attribute> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Attribute item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAttributes(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListAttributesResponse, Attribute> ListAttributes(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List all attributes.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for Attribute.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListAttributesResponseAttribute |
A pageable sequence of Attribute resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<gcav::ListAttributesResponse, gcav::Attribute> response = apiHubClient.ListAttributes(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Attribute item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListAttributesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Attribute item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Attribute> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Attribute item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAttributesAsync(LocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListAttributesResponse, Attribute> ListAttributesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List all attributes.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource for Attribute.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListAttributesResponseAttribute |
A pageable asynchronous sequence of Attribute resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<gcav::ListAttributesResponse, gcav::Attribute> response = apiHubClient.ListAttributesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Attribute item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListAttributesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Attribute item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Attribute> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Attribute item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAttributesAsync(ListAttributesRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListAttributesResponse, Attribute> ListAttributesAsync(ListAttributesRequest request, CallSettings callSettings = null)
List all attributes.
Parameters | |
---|---|
Name | Description |
request |
ListAttributesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListAttributesResponseAttribute |
A pageable asynchronous sequence of Attribute resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ListAttributesRequest request = new gcav::ListAttributesRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<gcav::ListAttributesResponse, gcav::Attribute> response = apiHubClient.ListAttributesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Attribute item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListAttributesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Attribute item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Attribute> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Attribute item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAttributesAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListAttributesResponse, Attribute> ListAttributesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List all attributes.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource for Attribute.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListAttributesResponseAttribute |
A pageable asynchronous sequence of Attribute resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<gcav::ListAttributesResponse, gcav::Attribute> response = apiHubClient.ListAttributesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Attribute item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListAttributesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Attribute item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Attribute> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Attribute item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDeployments(LocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent, which owns this collection of deployment resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListDeploymentsResponseDeployment |
A pageable sequence of Deployment resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<gcav::ListDeploymentsResponse, gcav::Deployment> response = apiHubClient.ListDeployments(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Deployment item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListDeploymentsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Deployment item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Deployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Deployment item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDeployments(ListDeploymentsRequest, CallSettings)
public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(ListDeploymentsRequest request, CallSettings callSettings = null)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListDeploymentsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListDeploymentsResponseDeployment |
A pageable sequence of Deployment resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ListDeploymentsRequest request = new gcav::ListDeploymentsRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
};
// Make the request
PagedEnumerable<gcav::ListDeploymentsResponse, gcav::Deployment> response = apiHubClient.ListDeployments(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Deployment item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListDeploymentsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Deployment item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Deployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Deployment item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDeployments(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of deployment resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListDeploymentsResponseDeployment |
A pageable sequence of Deployment resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<gcav::ListDeploymentsResponse, gcav::Deployment> response = apiHubClient.ListDeployments(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Deployment item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListDeploymentsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Deployment item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Deployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Deployment item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDeploymentsAsync(LocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent, which owns this collection of deployment resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListDeploymentsResponseDeployment |
A pageable asynchronous sequence of Deployment resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<gcav::ListDeploymentsResponse, gcav::Deployment> response = apiHubClient.ListDeploymentsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Deployment item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListDeploymentsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Deployment item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Deployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Deployment item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDeploymentsAsync(ListDeploymentsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(ListDeploymentsRequest request, CallSettings callSettings = null)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListDeploymentsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListDeploymentsResponseDeployment |
A pageable asynchronous sequence of Deployment resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ListDeploymentsRequest request = new gcav::ListDeploymentsRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<gcav::ListDeploymentsResponse, gcav::Deployment> response = apiHubClient.ListDeploymentsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Deployment item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListDeploymentsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Deployment item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Deployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Deployment item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDeploymentsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List deployment resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of deployment resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListDeploymentsResponseDeployment |
A pageable asynchronous sequence of Deployment resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<gcav::ListDeploymentsResponse, gcav::Deployment> response = apiHubClient.ListDeploymentsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Deployment item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListDeploymentsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Deployment item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Deployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Deployment item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListExternalApis(LocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApis(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent, which owns this collection of External API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListExternalApisResponseExternalApi |
A pageable sequence of ExternalApi resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<gcav::ListExternalApisResponse, gcav::ExternalApi> response = apiHubClient.ListExternalApis(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::ExternalApi item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListExternalApisResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ExternalApi item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ExternalApi> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ExternalApi item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListExternalApis(ListExternalApisRequest, CallSettings)
public virtual PagedEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApis(ListExternalApisRequest request, CallSettings callSettings = null)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListExternalApisRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListExternalApisResponseExternalApi |
A pageable sequence of ExternalApi resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ListExternalApisRequest request = new gcav::ListExternalApisRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<gcav::ListExternalApisResponse, gcav::ExternalApi> response = apiHubClient.ListExternalApis(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::ExternalApi item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListExternalApisResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ExternalApi item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ExternalApi> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ExternalApi item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListExternalApis(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApis(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of External API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListExternalApisResponseExternalApi |
A pageable sequence of ExternalApi resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<gcav::ListExternalApisResponse, gcav::ExternalApi> response = apiHubClient.ListExternalApis(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::ExternalApi item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListExternalApisResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ExternalApi item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ExternalApi> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ExternalApi item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListExternalApisAsync(LocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApisAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent, which owns this collection of External API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListExternalApisResponseExternalApi |
A pageable asynchronous sequence of ExternalApi resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<gcav::ListExternalApisResponse, gcav::ExternalApi> response = apiHubClient.ListExternalApisAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::ExternalApi item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListExternalApisResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ExternalApi item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ExternalApi> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ExternalApi item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListExternalApisAsync(ListExternalApisRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApisAsync(ListExternalApisRequest request, CallSettings callSettings = null)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListExternalApisRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListExternalApisResponseExternalApi |
A pageable asynchronous sequence of ExternalApi resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ListExternalApisRequest request = new gcav::ListExternalApisRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<gcav::ListExternalApisResponse, gcav::ExternalApi> response = apiHubClient.ListExternalApisAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::ExternalApi item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListExternalApisResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ExternalApi item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ExternalApi> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ExternalApi item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListExternalApisAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListExternalApisResponse, ExternalApi> ListExternalApisAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List External API resources in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of External API resources.
Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListExternalApisResponseExternalApi |
A pageable asynchronous sequence of ExternalApi resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<gcav::ListExternalApisResponse, gcav::ExternalApi> response = apiHubClient.ListExternalApisAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::ExternalApi item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListExternalApisResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::ExternalApi item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::ExternalApi> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::ExternalApi item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSpecs(ListSpecsRequest, CallSettings)
public virtual PagedEnumerable<ListSpecsResponse, Spec> ListSpecs(ListSpecsRequest request, CallSettings callSettings = null)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
request |
ListSpecsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListSpecsResponseSpec |
A pageable sequence of Spec resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ListSpecsRequest request = new gcav::ListSpecsRequest
{
ParentAsVersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
Filter = "",
};
// Make the request
PagedEnumerable<gcav::ListSpecsResponse, gcav::Spec> response = apiHubClient.ListSpecs(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Spec item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListSpecsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Spec item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Spec> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Spec item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSpecs(VersionName, string, int?, CallSettings)
public virtual PagedEnumerable<ListSpecsResponse, Spec> ListSpecs(VersionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
parent |
VersionName Required. The parent, which owns this collection of specs.
Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListSpecsResponseSpec |
A pageable sequence of Spec resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::VersionName parent = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
PagedEnumerable<gcav::ListSpecsResponse, gcav::Spec> response = apiHubClient.ListSpecs(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Spec item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListSpecsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Spec item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Spec> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Spec item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSpecs(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListSpecsResponse, Spec> ListSpecs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of specs.
Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListSpecsResponseSpec |
A pageable sequence of Spec resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
PagedEnumerable<gcav::ListSpecsResponse, gcav::Spec> response = apiHubClient.ListSpecs(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Spec item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListSpecsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Spec item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Spec> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Spec item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSpecsAsync(ListSpecsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListSpecsResponse, Spec> ListSpecsAsync(ListSpecsRequest request, CallSettings callSettings = null)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
request |
ListSpecsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListSpecsResponseSpec |
A pageable asynchronous sequence of Spec resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ListSpecsRequest request = new gcav::ListSpecsRequest
{
ParentAsVersionName = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<gcav::ListSpecsResponse, gcav::Spec> response = apiHubClient.ListSpecsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Spec item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListSpecsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Spec item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Spec> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Spec item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSpecsAsync(VersionName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListSpecsResponse, Spec> ListSpecsAsync(VersionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
parent |
VersionName Required. The parent, which owns this collection of specs.
Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListSpecsResponseSpec |
A pageable asynchronous sequence of Spec resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::VersionName parent = gcav::VersionName.FromProjectLocationApiVersion("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
// Make the request
PagedAsyncEnumerable<gcav::ListSpecsResponse, gcav::Spec> response = apiHubClient.ListSpecsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Spec item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListSpecsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Spec item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Spec> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Spec item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSpecsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListSpecsResponse, Spec> ListSpecsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List specs corresponding to a particular API resource.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent, which owns this collection of specs.
Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListSpecsResponseSpec |
A pageable asynchronous sequence of Spec resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]/versions/[VERSION]";
// Make the request
PagedAsyncEnumerable<gcav::ListSpecsResponse, gcav::Spec> response = apiHubClient.ListSpecsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Spec item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListSpecsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Spec item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Spec> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Spec item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListVersions(ApiName, string, int?, CallSettings)
public virtual PagedEnumerable<ListVersionsResponse, Version> ListVersions(ApiName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
ApiName Required. The parent which owns this collection of API versions i.e., the
API resource Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListVersionsResponseVersion |
A pageable sequence of Version resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ApiName parent = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
PagedEnumerable<gcav::ListVersionsResponse, gcav::Version> response = apiHubClient.ListVersions(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Version item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListVersionsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Version item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Version> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Version item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListVersions(ListVersionsRequest, CallSettings)
public virtual PagedEnumerable<ListVersionsResponse, Version> ListVersions(ListVersionsRequest request, CallSettings callSettings = null)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListVersionsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListVersionsResponseVersion |
A pageable sequence of Version resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ListVersionsRequest request = new gcav::ListVersionsRequest
{
ParentAsApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
Filter = "",
};
// Make the request
PagedEnumerable<gcav::ListVersionsResponse, gcav::Version> response = apiHubClient.ListVersions(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Version item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListVersionsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Version item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Version> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Version item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListVersions(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListVersionsResponse, Version> ListVersions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent which owns this collection of API versions i.e., the
API resource Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListVersionsResponseVersion |
A pageable sequence of Version resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
PagedEnumerable<gcav::ListVersionsResponse, gcav::Version> response = apiHubClient.ListVersions(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Version item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListVersionsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Version item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Version> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Version item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListVersionsAsync(ApiName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(ApiName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
ApiName Required. The parent which owns this collection of API versions i.e., the
API resource Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListVersionsResponseVersion |
A pageable asynchronous sequence of Version resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ApiName parent = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]");
// Make the request
PagedAsyncEnumerable<gcav::ListVersionsResponse, gcav::Version> response = apiHubClient.ListVersionsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Version item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListVersionsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Version item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Version> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Version item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListVersionsAsync(ListVersionsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(ListVersionsRequest request, CallSettings callSettings = null)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
request |
ListVersionsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListVersionsResponseVersion |
A pageable asynchronous sequence of Version resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ListVersionsRequest request = new gcav::ListVersionsRequest
{
ParentAsApiName = gcav::ApiName.FromProjectLocationApi("[PROJECT]", "[LOCATION]", "[API]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<gcav::ListVersionsResponse, gcav::Version> response = apiHubClient.ListVersionsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Version item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListVersionsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Version item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Version> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Version item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListVersionsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
List API versions of an API resource in the API hub.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent which owns this collection of API versions i.e., the
API resource Format: |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListVersionsResponseVersion |
A pageable asynchronous sequence of Version resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/apis/[API]";
// Make the request
PagedAsyncEnumerable<gcav::ListVersionsResponse, gcav::Version> response = apiHubClient.ListVersionsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Version item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListVersionsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::Version item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Version> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Version item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchResources(LocationName, string, string, int?, CallSettings)
public virtual PagedEnumerable<SearchResourcesResponse, SearchResult> SearchResources(LocationName location, string query, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
location |
LocationName Required. The resource name of the location which will be of the type
|
query |
string Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchResourcesResponseSearchResult |
A pageable sequence of SearchResult resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
PagedEnumerable<gcav::SearchResourcesResponse, gcav::SearchResult> response = apiHubClient.SearchResources(location, query);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::SearchResult item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::SearchResourcesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::SearchResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::SearchResult> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::SearchResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchResources(SearchResourcesRequest, CallSettings)
public virtual PagedEnumerable<SearchResourcesResponse, SearchResult> SearchResources(SearchResourcesRequest request, CallSettings callSettings = null)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
request |
SearchResourcesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchResourcesResponseSearchResult |
A pageable sequence of SearchResult resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::SearchResourcesRequest request = new gcav::SearchResourcesRequest
{
LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Query = "",
Filter = "",
};
// Make the request
PagedEnumerable<gcav::SearchResourcesResponse, gcav::SearchResult> response = apiHubClient.SearchResources(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::SearchResult item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::SearchResourcesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::SearchResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::SearchResult> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::SearchResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchResources(string, string, string, int?, CallSettings)
public virtual PagedEnumerable<SearchResourcesResponse, SearchResult> SearchResources(string location, string query, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
location |
string Required. The resource name of the location which will be of the type
|
query |
string Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchResourcesResponseSearchResult |
A pageable sequence of SearchResult resources. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
PagedEnumerable<gcav::SearchResourcesResponse, gcav::SearchResult> response = apiHubClient.SearchResources(location, query);
// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::SearchResult item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::SearchResourcesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::SearchResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::SearchResult> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::SearchResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchResourcesAsync(LocationName, string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<SearchResourcesResponse, SearchResult> SearchResourcesAsync(LocationName location, string query, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
location |
LocationName Required. The resource name of the location which will be of the type
|
query |
string Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchResourcesResponseSearchResult |
A pageable asynchronous sequence of SearchResult resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
PagedAsyncEnumerable<gcav::SearchResourcesResponse, gcav::SearchResult> response = apiHubClient.SearchResourcesAsync(location, query);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::SearchResult item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::SearchResourcesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::SearchResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::SearchResult> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::SearchResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchResourcesAsync(SearchResourcesRequest, CallSettings)
public virtual PagedAsyncEnumerable<SearchResourcesResponse, SearchResult> SearchResourcesAsync(SearchResourcesRequest request, CallSettings callSettings = null)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
request |
SearchResourcesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchResourcesResponseSearchResult |
A pageable asynchronous sequence of SearchResult resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::SearchResourcesRequest request = new gcav::SearchResourcesRequest
{
LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Query = "",
Filter = "",
};
// Make the request
PagedAsyncEnumerable<gcav::SearchResourcesResponse, gcav::SearchResult> response = apiHubClient.SearchResourcesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::SearchResult item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::SearchResourcesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::SearchResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::SearchResult> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::SearchResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchResourcesAsync(string, string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<SearchResourcesResponse, SearchResult> SearchResourcesAsync(string location, string query, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Search across API-Hub resources.
Parameters | |
---|---|
Name | Description |
location |
string Required. The resource name of the location which will be of the type
|
query |
string Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchResourcesResponseSearchResult |
A pageable asynchronous sequence of SearchResult resources. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
PagedAsyncEnumerable<gcav::SearchResourcesResponse, gcav::SearchResult> response = apiHubClient.SearchResourcesAsync(location, query);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::SearchResult item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::SearchResourcesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (gcav::SearchResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::SearchResult> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::SearchResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task |
A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
UpdateApi(Api, FieldMask, CallSettings)
public virtual Api UpdateApi(Api api, FieldMask updateMask, CallSettings callSettings = null)
Update an API resource in the API hub. The following fields in the [API][] can be updated:
- [display_name][google.cloud.apihub.v1.Api.display_name]
- [description][google.cloud.apihub.v1.Api.description]
- [owner][google.cloud.apihub.v1.Api.owner]
- [documentation][google.cloud.apihub.v1.Api.documentation]
- [target_user][google.cloud.apihub.v1.Api.target_user]
- [team][google.cloud.apihub.v1.Api.team]
- [business_unit][google.cloud.apihub.v1.Api.business_unit]
- [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
- [attributes][google.cloud.apihub.v1.Api.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.
Updating the owner field requires complete owner message and updates both owner and email fields.
Parameters | |
---|---|
Name | Description |
api |
Api Required. The API resource to update. The API resource's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::Api api = new gcav::Api();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Api response = apiHubClient.UpdateApi(api, updateMask);
UpdateApi(UpdateApiRequest, CallSettings)
public virtual Api UpdateApi(UpdateApiRequest request, CallSettings callSettings = null)
Update an API resource in the API hub. The following fields in the [API][] can be updated:
- [display_name][google.cloud.apihub.v1.Api.display_name]
- [description][google.cloud.apihub.v1.Api.description]
- [owner][google.cloud.apihub.v1.Api.owner]
- [documentation][google.cloud.apihub.v1.Api.documentation]
- [target_user][google.cloud.apihub.v1.Api.target_user]
- [team][google.cloud.apihub.v1.Api.team]
- [business_unit][google.cloud.apihub.v1.Api.business_unit]
- [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
- [attributes][google.cloud.apihub.v1.Api.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.
Updating the owner field requires complete owner message and updates both owner and email fields.
Parameters | |
---|---|
Name | Description |
request |
UpdateApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::UpdateApiRequest request = new gcav::UpdateApiRequest
{
Api = new gcav::Api(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Api response = apiHubClient.UpdateApi(request);
UpdateApiAsync(Api, FieldMask, CallSettings)
public virtual Task<Api> UpdateApiAsync(Api api, FieldMask updateMask, CallSettings callSettings = null)
Update an API resource in the API hub. The following fields in the [API][] can be updated:
- [display_name][google.cloud.apihub.v1.Api.display_name]
- [description][google.cloud.apihub.v1.Api.description]
- [owner][google.cloud.apihub.v1.Api.owner]
- [documentation][google.cloud.apihub.v1.Api.documentation]
- [target_user][google.cloud.apihub.v1.Api.target_user]
- [team][google.cloud.apihub.v1.Api.team]
- [business_unit][google.cloud.apihub.v1.Api.business_unit]
- [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
- [attributes][google.cloud.apihub.v1.Api.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.
Updating the owner field requires complete owner message and updates both owner and email fields.
Parameters | |
---|---|
Name | Description |
api |
Api Required. The API resource to update. The API resource's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Api api = new gcav::Api();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Api response = await apiHubClient.UpdateApiAsync(api, updateMask);
UpdateApiAsync(Api, FieldMask, CancellationToken)
public virtual Task<Api> UpdateApiAsync(Api api, FieldMask updateMask, CancellationToken cancellationToken)
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 |
api |
Api Required. The API resource to update. The API resource's |
updateMask |
FieldMask Required. The list of fields to update. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Api api = new gcav::Api();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Api response = await apiHubClient.UpdateApiAsync(api, updateMask);
UpdateApiAsync(UpdateApiRequest, CallSettings)
public virtual Task<Api> UpdateApiAsync(UpdateApiRequest request, CallSettings callSettings = null)
Update an API resource in the API hub. The following fields in the [API][] can be updated:
- [display_name][google.cloud.apihub.v1.Api.display_name]
- [description][google.cloud.apihub.v1.Api.description]
- [owner][google.cloud.apihub.v1.Api.owner]
- [documentation][google.cloud.apihub.v1.Api.documentation]
- [target_user][google.cloud.apihub.v1.Api.target_user]
- [team][google.cloud.apihub.v1.Api.team]
- [business_unit][google.cloud.apihub.v1.Api.business_unit]
- [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
- [attributes][google.cloud.apihub.v1.Api.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.
Updating the owner field requires complete owner message and updates both owner and email fields.
Parameters | |
---|---|
Name | Description |
request |
UpdateApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateApiRequest request = new gcav::UpdateApiRequest
{
Api = new gcav::Api(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Api response = await apiHubClient.UpdateApiAsync(request);
UpdateApiAsync(UpdateApiRequest, CancellationToken)
public virtual Task<Api> UpdateApiAsync(UpdateApiRequest request, CancellationToken cancellationToken)
Update an API resource in the API hub. The following fields in the [API][] can be updated:
- [display_name][google.cloud.apihub.v1.Api.display_name]
- [description][google.cloud.apihub.v1.Api.description]
- [owner][google.cloud.apihub.v1.Api.owner]
- [documentation][google.cloud.apihub.v1.Api.documentation]
- [target_user][google.cloud.apihub.v1.Api.target_user]
- [team][google.cloud.apihub.v1.Api.team]
- [business_unit][google.cloud.apihub.v1.Api.business_unit]
- [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
- [attributes][google.cloud.apihub.v1.Api.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.
Updating the owner field requires complete owner message and updates both owner and email fields.
Parameters | |
---|---|
Name | Description |
request |
UpdateApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateApiRequest request = new gcav::UpdateApiRequest
{
Api = new gcav::Api(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Api response = await apiHubClient.UpdateApiAsync(request);
UpdateAttribute(Attribute, FieldMask, CallSettings)
public virtual Attribute UpdateAttribute(Attribute attribute, FieldMask updateMask, CallSettings callSettings = null)
Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:
- [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only.
- [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only.
- [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted.
- [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update.
The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
attribute |
Attribute Required. The attribute to update. The attribute's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::Attribute attribute = new gcav::Attribute();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Attribute response = apiHubClient.UpdateAttribute(attribute, updateMask);
UpdateAttribute(UpdateAttributeRequest, CallSettings)
public virtual Attribute UpdateAttribute(UpdateAttributeRequest request, CallSettings callSettings = null)
Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:
- [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only.
- [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only.
- [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted.
- [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update.
The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Attribute |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::UpdateAttributeRequest request = new gcav::UpdateAttributeRequest
{
Attribute = new gcav::Attribute(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Attribute response = apiHubClient.UpdateAttribute(request);
UpdateAttributeAsync(Attribute, FieldMask, CallSettings)
public virtual Task<Attribute> UpdateAttributeAsync(Attribute attribute, FieldMask updateMask, CallSettings callSettings = null)
Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:
- [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only.
- [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only.
- [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted.
- [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update.
The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
attribute |
Attribute Required. The attribute to update. The attribute's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Attribute attribute = new gcav::Attribute();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Attribute response = await apiHubClient.UpdateAttributeAsync(attribute, updateMask);
UpdateAttributeAsync(Attribute, FieldMask, CancellationToken)
public virtual Task<Attribute> UpdateAttributeAsync(Attribute attribute, FieldMask updateMask, CancellationToken cancellationToken)
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 |
attribute |
Attribute Required. The attribute to update. The attribute's |
updateMask |
FieldMask Required. The list of fields to update. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Attribute attribute = new gcav::Attribute();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Attribute response = await apiHubClient.UpdateAttributeAsync(attribute, updateMask);
UpdateAttributeAsync(UpdateAttributeRequest, CallSettings)
public virtual Task<Attribute> UpdateAttributeAsync(UpdateAttributeRequest request, CallSettings callSettings = null)
Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:
- [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only.
- [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only.
- [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted.
- [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update.
The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateAttributeRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateAttributeRequest request = new gcav::UpdateAttributeRequest
{
Attribute = new gcav::Attribute(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Attribute response = await apiHubClient.UpdateAttributeAsync(request);
UpdateAttributeAsync(UpdateAttributeRequest, CancellationToken)
public virtual Task<Attribute> UpdateAttributeAsync(UpdateAttributeRequest request, CancellationToken cancellationToken)
Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:
- [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only.
- [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only.
- [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted.
- [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update.
The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateAttributeRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAttribute |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateAttributeRequest request = new gcav::UpdateAttributeRequest
{
Attribute = new gcav::Attribute(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Attribute response = await apiHubClient.UpdateAttributeAsync(request);
UpdateDeployment(Deployment, FieldMask, CallSettings)
public virtual Deployment UpdateDeployment(Deployment deployment, FieldMask updateMask, CallSettings callSettings = null)
Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated:
- [display_name][google.cloud.apihub.v1.Deployment.display_name]
- [description][google.cloud.apihub.v1.Deployment.description]
- [documentation][google.cloud.apihub.v1.Deployment.documentation]
- [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
- [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
- [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
- [slo][google.cloud.apihub.v1.Deployment.slo]
- [environment][google.cloud.apihub.v1.Deployment.environment]
- [attributes][google.cloud.apihub.v1.Deployment.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
deployment |
Deployment Required. The deployment resource to update. The deployment resource's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::Deployment deployment = new gcav::Deployment();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Deployment response = apiHubClient.UpdateDeployment(deployment, updateMask);
UpdateDeployment(UpdateDeploymentRequest, CallSettings)
public virtual Deployment UpdateDeployment(UpdateDeploymentRequest request, CallSettings callSettings = null)
Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated:
- [display_name][google.cloud.apihub.v1.Deployment.display_name]
- [description][google.cloud.apihub.v1.Deployment.description]
- [documentation][google.cloud.apihub.v1.Deployment.documentation]
- [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
- [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
- [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
- [slo][google.cloud.apihub.v1.Deployment.slo]
- [environment][google.cloud.apihub.v1.Deployment.environment]
- [attributes][google.cloud.apihub.v1.Deployment.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Deployment |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::UpdateDeploymentRequest request = new gcav::UpdateDeploymentRequest
{
Deployment = new gcav::Deployment(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Deployment response = apiHubClient.UpdateDeployment(request);
UpdateDeploymentAsync(Deployment, FieldMask, CallSettings)
public virtual Task<Deployment> UpdateDeploymentAsync(Deployment deployment, FieldMask updateMask, CallSettings callSettings = null)
Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated:
- [display_name][google.cloud.apihub.v1.Deployment.display_name]
- [description][google.cloud.apihub.v1.Deployment.description]
- [documentation][google.cloud.apihub.v1.Deployment.documentation]
- [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
- [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
- [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
- [slo][google.cloud.apihub.v1.Deployment.slo]
- [environment][google.cloud.apihub.v1.Deployment.environment]
- [attributes][google.cloud.apihub.v1.Deployment.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
deployment |
Deployment Required. The deployment resource to update. The deployment resource's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Deployment deployment = new gcav::Deployment();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Deployment response = await apiHubClient.UpdateDeploymentAsync(deployment, updateMask);
UpdateDeploymentAsync(Deployment, FieldMask, CancellationToken)
public virtual Task<Deployment> UpdateDeploymentAsync(Deployment deployment, FieldMask updateMask, CancellationToken cancellationToken)
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 |
deployment |
Deployment Required. The deployment resource to update. The deployment resource's |
updateMask |
FieldMask Required. The list of fields to update. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Deployment deployment = new gcav::Deployment();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Deployment response = await apiHubClient.UpdateDeploymentAsync(deployment, updateMask);
UpdateDeploymentAsync(UpdateDeploymentRequest, CallSettings)
public virtual Task<Deployment> UpdateDeploymentAsync(UpdateDeploymentRequest request, CallSettings callSettings = null)
Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated:
- [display_name][google.cloud.apihub.v1.Deployment.display_name]
- [description][google.cloud.apihub.v1.Deployment.description]
- [documentation][google.cloud.apihub.v1.Deployment.documentation]
- [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
- [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
- [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
- [slo][google.cloud.apihub.v1.Deployment.slo]
- [environment][google.cloud.apihub.v1.Deployment.environment]
- [attributes][google.cloud.apihub.v1.Deployment.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateDeploymentRequest request = new gcav::UpdateDeploymentRequest
{
Deployment = new gcav::Deployment(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Deployment response = await apiHubClient.UpdateDeploymentAsync(request);
UpdateDeploymentAsync(UpdateDeploymentRequest, CancellationToken)
public virtual Task<Deployment> UpdateDeploymentAsync(UpdateDeploymentRequest request, CancellationToken cancellationToken)
Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated:
- [display_name][google.cloud.apihub.v1.Deployment.display_name]
- [description][google.cloud.apihub.v1.Deployment.description]
- [documentation][google.cloud.apihub.v1.Deployment.documentation]
- [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
- [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
- [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
- [slo][google.cloud.apihub.v1.Deployment.slo]
- [environment][google.cloud.apihub.v1.Deployment.environment]
- [attributes][google.cloud.apihub.v1.Deployment.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateDeploymentRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeployment |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateDeploymentRequest request = new gcav::UpdateDeploymentRequest
{
Deployment = new gcav::Deployment(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Deployment response = await apiHubClient.UpdateDeploymentAsync(request);
UpdateExternalApi(ExternalApi, FieldMask, CallSettings)
public virtual ExternalApi UpdateExternalApi(ExternalApi externalApi, FieldMask updateMask, CallSettings callSettings = null)
Update an External API resource in the API hub. The following fields can be updated:
- [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
- [description][google.cloud.apihub.v1.ExternalApi.description]
- [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
- [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
- [paths][google.cloud.apihub.v1.ExternalApi.paths]
The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
externalApi |
ExternalApi Required. The External API resource to update. The External API resource's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::ExternalApi externalApi = new gcav::ExternalApi();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::ExternalApi response = apiHubClient.UpdateExternalApi(externalApi, updateMask);
UpdateExternalApi(UpdateExternalApiRequest, CallSettings)
public virtual ExternalApi UpdateExternalApi(UpdateExternalApiRequest request, CallSettings callSettings = null)
Update an External API resource in the API hub. The following fields can be updated:
- [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
- [description][google.cloud.apihub.v1.ExternalApi.description]
- [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
- [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
- [paths][google.cloud.apihub.v1.ExternalApi.paths]
The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ExternalApi |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::UpdateExternalApiRequest request = new gcav::UpdateExternalApiRequest
{
ExternalApi = new gcav::ExternalApi(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::ExternalApi response = apiHubClient.UpdateExternalApi(request);
UpdateExternalApiAsync(ExternalApi, FieldMask, CallSettings)
public virtual Task<ExternalApi> UpdateExternalApiAsync(ExternalApi externalApi, FieldMask updateMask, CallSettings callSettings = null)
Update an External API resource in the API hub. The following fields can be updated:
- [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
- [description][google.cloud.apihub.v1.ExternalApi.description]
- [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
- [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
- [paths][google.cloud.apihub.v1.ExternalApi.paths]
The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
externalApi |
ExternalApi Required. The External API resource to update. The External API resource's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ExternalApi externalApi = new gcav::ExternalApi();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::ExternalApi response = await apiHubClient.UpdateExternalApiAsync(externalApi, updateMask);
UpdateExternalApiAsync(ExternalApi, FieldMask, CancellationToken)
public virtual Task<ExternalApi> UpdateExternalApiAsync(ExternalApi externalApi, FieldMask updateMask, CancellationToken cancellationToken)
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 |
externalApi |
ExternalApi Required. The External API resource to update. The External API resource's |
updateMask |
FieldMask Required. The list of fields to update. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::ExternalApi externalApi = new gcav::ExternalApi();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::ExternalApi response = await apiHubClient.UpdateExternalApiAsync(externalApi, updateMask);
UpdateExternalApiAsync(UpdateExternalApiRequest, CallSettings)
public virtual Task<ExternalApi> UpdateExternalApiAsync(UpdateExternalApiRequest request, CallSettings callSettings = null)
Update an External API resource in the API hub. The following fields can be updated:
- [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
- [description][google.cloud.apihub.v1.ExternalApi.description]
- [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
- [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
- [paths][google.cloud.apihub.v1.ExternalApi.paths]
The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateExternalApiRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateExternalApiRequest request = new gcav::UpdateExternalApiRequest
{
ExternalApi = new gcav::ExternalApi(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::ExternalApi response = await apiHubClient.UpdateExternalApiAsync(request);
UpdateExternalApiAsync(UpdateExternalApiRequest, CancellationToken)
public virtual Task<ExternalApi> UpdateExternalApiAsync(UpdateExternalApiRequest request, CancellationToken cancellationToken)
Update an External API resource in the API hub. The following fields can be updated:
- [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
- [description][google.cloud.apihub.v1.ExternalApi.description]
- [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
- [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
- [paths][google.cloud.apihub.v1.ExternalApi.paths]
The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateExternalApiRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskExternalApi |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateExternalApiRequest request = new gcav::UpdateExternalApiRequest
{
ExternalApi = new gcav::ExternalApi(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::ExternalApi response = await apiHubClient.UpdateExternalApiAsync(request);
UpdateSpec(Spec, FieldMask, CallSettings)
public virtual Spec UpdateSpec(Spec spec, FieldMask updateMask, CallSettings callSettings = null)
Update spec. The following fields in the [spec][google.cloud.apihub.v1.Spec] can be updated:
- [display_name][google.cloud.apihub.v1.Spec.display_name]
- [source_uri][google.cloud.apihub.v1.Spec.source_uri]
- [lint_response][google.cloud.apihub.v1.Spec.lint_response]
- [attributes][google.cloud.apihub.v1.Spec.attributes]
- [contents][google.cloud.apihub.v1.Spec.contents]
- [spec_type][google.cloud.apihub.v1.Spec.spec_type]
In case of an OAS spec, updating spec contents can lead to:
- 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 |
spec |
Spec Required. The spec to update. The spec's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::Spec spec = new gcav::Spec();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Spec response = apiHubClient.UpdateSpec(spec, updateMask);
UpdateSpec(UpdateSpecRequest, CallSettings)
public virtual Spec UpdateSpec(UpdateSpecRequest request, CallSettings callSettings = null)
Update spec. The following fields in the [spec][google.cloud.apihub.v1.Spec] can be updated:
- [display_name][google.cloud.apihub.v1.Spec.display_name]
- [source_uri][google.cloud.apihub.v1.Spec.source_uri]
- [lint_response][google.cloud.apihub.v1.Spec.lint_response]
- [attributes][google.cloud.apihub.v1.Spec.attributes]
- [contents][google.cloud.apihub.v1.Spec.contents]
- [spec_type][google.cloud.apihub.v1.Spec.spec_type]
In case of an OAS spec, updating spec contents can lead to:
- 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 object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Spec |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::UpdateSpecRequest request = new gcav::UpdateSpecRequest
{
Spec = new gcav::Spec(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Spec response = apiHubClient.UpdateSpec(request);
UpdateSpecAsync(Spec, FieldMask, CallSettings)
public virtual Task<Spec> UpdateSpecAsync(Spec spec, FieldMask updateMask, CallSettings callSettings = null)
Update spec. The following fields in the [spec][google.cloud.apihub.v1.Spec] can be updated:
- [display_name][google.cloud.apihub.v1.Spec.display_name]
- [source_uri][google.cloud.apihub.v1.Spec.source_uri]
- [lint_response][google.cloud.apihub.v1.Spec.lint_response]
- [attributes][google.cloud.apihub.v1.Spec.attributes]
- [contents][google.cloud.apihub.v1.Spec.contents]
- [spec_type][google.cloud.apihub.v1.Spec.spec_type]
In case of an OAS spec, updating spec contents can lead to:
- 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 |
spec |
Spec Required. The spec to update. The spec's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Spec spec = new gcav::Spec();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Spec response = await apiHubClient.UpdateSpecAsync(spec, updateMask);
UpdateSpecAsync(Spec, FieldMask, CancellationToken)
public virtual Task<Spec> UpdateSpecAsync(Spec spec, FieldMask updateMask, CancellationToken cancellationToken)
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 |
spec |
Spec Required. The spec to update. The spec's |
updateMask |
FieldMask Required. The list of fields to update. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Spec spec = new gcav::Spec();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Spec response = await apiHubClient.UpdateSpecAsync(spec, updateMask);
UpdateSpecAsync(UpdateSpecRequest, CallSettings)
public virtual Task<Spec> UpdateSpecAsync(UpdateSpecRequest request, CallSettings callSettings = null)
Update spec. The following fields in the [spec][google.cloud.apihub.v1.Spec] can be updated:
- [display_name][google.cloud.apihub.v1.Spec.display_name]
- [source_uri][google.cloud.apihub.v1.Spec.source_uri]
- [lint_response][google.cloud.apihub.v1.Spec.lint_response]
- [attributes][google.cloud.apihub.v1.Spec.attributes]
- [contents][google.cloud.apihub.v1.Spec.contents]
- [spec_type][google.cloud.apihub.v1.Spec.spec_type]
In case of an OAS spec, updating spec contents can lead to:
- 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 object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateSpecRequest request = new gcav::UpdateSpecRequest
{
Spec = new gcav::Spec(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Spec response = await apiHubClient.UpdateSpecAsync(request);
UpdateSpecAsync(UpdateSpecRequest, CancellationToken)
public virtual Task<Spec> UpdateSpecAsync(UpdateSpecRequest request, CancellationToken cancellationToken)
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 object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskSpec |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateSpecRequest request = new gcav::UpdateSpecRequest
{
Spec = new gcav::Spec(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Spec response = await apiHubClient.UpdateSpecAsync(request);
UpdateVersion(UpdateVersionRequest, CallSettings)
public virtual Version UpdateVersion(UpdateVersionRequest request, CallSettings callSettings = null)
Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently:
- [display_name][google.cloud.apihub.v1.Version.display_name]
- [description][google.cloud.apihub.v1.Version.description]
- [documentation][google.cloud.apihub.v1.Version.documentation]
- [deployments][google.cloud.apihub.v1.Version.deployments]
- [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
- [compliance][google.cloud.apihub.v1.Version.compliance]
- [accreditation][google.cloud.apihub.v1.Version.accreditation]
- [attributes][google.cloud.apihub.v1.Version.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::UpdateVersionRequest request = new gcav::UpdateVersionRequest
{
Version = new gcav::Version(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Version response = apiHubClient.UpdateVersion(request);
UpdateVersion(Version, FieldMask, CallSettings)
public virtual Version UpdateVersion(Version version, FieldMask updateMask, CallSettings callSettings = null)
Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently:
- [display_name][google.cloud.apihub.v1.Version.display_name]
- [description][google.cloud.apihub.v1.Version.description]
- [documentation][google.cloud.apihub.v1.Version.documentation]
- [deployments][google.cloud.apihub.v1.Version.deployments]
- [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
- [compliance][google.cloud.apihub.v1.Version.compliance]
- [accreditation][google.cloud.apihub.v1.Version.accreditation]
- [attributes][google.cloud.apihub.v1.Version.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
version |
Version Required. The API version to update. The version's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Version |
The RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = gcav::ApiHubClient.Create();
// Initialize request argument(s)
gcav::Version version = new gcav::Version();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Version response = apiHubClient.UpdateVersion(version, updateMask);
UpdateVersionAsync(UpdateVersionRequest, CallSettings)
public virtual Task<Version> UpdateVersionAsync(UpdateVersionRequest request, CallSettings callSettings = null)
Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently:
- [display_name][google.cloud.apihub.v1.Version.display_name]
- [description][google.cloud.apihub.v1.Version.description]
- [documentation][google.cloud.apihub.v1.Version.documentation]
- [deployments][google.cloud.apihub.v1.Version.deployments]
- [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
- [compliance][google.cloud.apihub.v1.Version.compliance]
- [accreditation][google.cloud.apihub.v1.Version.accreditation]
- [attributes][google.cloud.apihub.v1.Version.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateVersionRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateVersionRequest request = new gcav::UpdateVersionRequest
{
Version = new gcav::Version(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Version response = await apiHubClient.UpdateVersionAsync(request);
UpdateVersionAsync(UpdateVersionRequest, CancellationToken)
public virtual Task<Version> UpdateVersionAsync(UpdateVersionRequest request, CancellationToken cancellationToken)
Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently:
- [display_name][google.cloud.apihub.v1.Version.display_name]
- [description][google.cloud.apihub.v1.Version.description]
- [documentation][google.cloud.apihub.v1.Version.documentation]
- [deployments][google.cloud.apihub.v1.Version.deployments]
- [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
- [compliance][google.cloud.apihub.v1.Version.compliance]
- [accreditation][google.cloud.apihub.v1.Version.accreditation]
- [attributes][google.cloud.apihub.v1.Version.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
request |
UpdateVersionRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateVersionRequest request = new gcav::UpdateVersionRequest
{
Version = new gcav::Version(),
UpdateMask = new FieldMask(),
};
// Make the request
gcav::Version response = await apiHubClient.UpdateVersionAsync(request);
UpdateVersionAsync(Version, FieldMask, CallSettings)
public virtual Task<Version> UpdateVersionAsync(Version version, FieldMask updateMask, CallSettings callSettings = null)
Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently:
- [display_name][google.cloud.apihub.v1.Version.display_name]
- [description][google.cloud.apihub.v1.Version.description]
- [documentation][google.cloud.apihub.v1.Version.documentation]
- [deployments][google.cloud.apihub.v1.Version.deployments]
- [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
- [compliance][google.cloud.apihub.v1.Version.compliance]
- [accreditation][google.cloud.apihub.v1.Version.accreditation]
- [attributes][google.cloud.apihub.v1.Version.attributes]
The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.
Parameters | |
---|---|
Name | Description |
version |
Version Required. The API version to update. The version's |
updateMask |
FieldMask Required. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Version version = new gcav::Version();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Version response = await apiHubClient.UpdateVersionAsync(version, updateMask);
UpdateVersionAsync(Version, FieldMask, CancellationToken)
public virtual Task<Version> UpdateVersionAsync(Version version, FieldMask updateMask, CancellationToken cancellationToken)
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 |
version |
Version Required. The API version to update. The version's |
updateMask |
FieldMask Required. The list of fields to update. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskVersion |
A Task containing the RPC response. |
// Create client
gcav::ApiHubClient apiHubClient = await gcav::ApiHubClient.CreateAsync();
// Initialize request argument(s)
gcav::Version version = new gcav::Version();
FieldMask updateMask = new FieldMask();
// Make the request
gcav::Version response = await apiHubClient.UpdateVersionAsync(version, updateMask);