public abstract class ApiGatewayServiceClient
Reference documentation and code samples for the API Gateway v1 API class ApiGatewayServiceClient.
ApiGatewayService client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.ApiGateway.V1Assembly
Google.Cloud.ApiGateway.V1.dll
Remarks
The API Gateway Service is the interface for managing API Gateways.
Properties
CreateApiConfigOperationsClient
public virtual OperationsClient CreateApiConfigOperationsClient { get; }
The long-running operations client for CreateApiConfig
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateApiOperationsClient
public virtual OperationsClient CreateApiOperationsClient { get; }
The long-running operations client for CreateApi
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateGatewayOperationsClient
public virtual OperationsClient CreateGatewayOperationsClient { get; }
The long-running operations client for CreateGateway
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the ApiGatewayService service, which is a host of "apigateway.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default ApiGatewayService scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default ApiGatewayService scopes are:
DeleteApiConfigOperationsClient
public virtual OperationsClient DeleteApiConfigOperationsClient { get; }
The long-running operations client for DeleteApiConfig
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteApiOperationsClient
public virtual OperationsClient DeleteApiOperationsClient { get; }
The long-running operations client for DeleteApi
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteGatewayOperationsClient
public virtual OperationsClient DeleteGatewayOperationsClient { get; }
The long-running operations client for DeleteGateway
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public virtual ApiGatewayService.ApiGatewayServiceClient GrpcClient { get; }
The underlying gRPC ApiGatewayService client
Property Value | |
---|---|
Type | Description |
ApiGatewayService.ApiGatewayServiceClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
UpdateApiConfigOperationsClient
public virtual OperationsClient UpdateApiConfigOperationsClient { get; }
The long-running operations client for UpdateApiConfig
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateApiOperationsClient
public virtual OperationsClient UpdateApiOperationsClient { get; }
The long-running operations client for UpdateApi
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateGatewayOperationsClient
public virtual OperationsClient UpdateGatewayOperationsClient { get; }
The long-running operations client for UpdateGateway
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
Create()
public static ApiGatewayServiceClient Create()
Synchronously creates a ApiGatewayServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ApiGatewayServiceClientBuilder.
Returns | |
---|---|
Type | Description |
ApiGatewayServiceClient | The created ApiGatewayServiceClient. |
CreateApi(LocationName, Api, String, CallSettings)
public virtual Operation<Api, OperationMetadata> CreateApi(LocationName parent, Api api, string apiId, CallSettings callSettings = null)
Creates a new Api in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the API, of the form:
|
api | Api Required. API resource. |
apiId | String Required. Identifier to assign to the API. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Api, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
Operation<gcav::Api, OperationMetadata> response = apiGatewayServiceClient.CreateApi(parent, api, apiId);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApi(CreateApiRequest, CallSettings)
public virtual Operation<Api, OperationMetadata> CreateApi(CreateApiRequest request, CallSettings callSettings = null)
Creates a new Api in a given project and location.
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 |
Operation<Api, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
CreateApiRequest request = new CreateApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ApiId = "",
Api = new gcav::Api(),
};
// Make the request
Operation<gcav::Api, OperationMetadata> response = apiGatewayServiceClient.CreateApi(request);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApi(String, Api, String, CallSettings)
public virtual Operation<Api, OperationMetadata> CreateApi(string parent, Api api, string apiId, CallSettings callSettings = null)
Creates a new Api in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API, of the form:
|
api | Api Required. API resource. |
apiId | String Required. Identifier to assign to the API. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Api, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
Operation<gcav::Api, OperationMetadata> response = apiGatewayServiceClient.CreateApi(parent, api, apiId);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApiAsync(LocationName, Api, String, CallSettings)
public virtual Task<Operation<Api, OperationMetadata>> CreateApiAsync(LocationName parent, Api api, string apiId, CallSettings callSettings = null)
Creates a new Api in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the API, of the form:
|
api | Api Required. API resource. |
apiId | String Required. Identifier to assign to the API. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.CreateApiAsync(parent, api, apiId);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApiAsync(LocationName, Api, String, CancellationToken)
public virtual Task<Operation<Api, OperationMetadata>> CreateApiAsync(LocationName parent, Api api, string apiId, CancellationToken cancellationToken)
Creates a new Api in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the API, of the form:
|
api | Api Required. API resource. |
apiId | String Required. Identifier to assign to the API. Must be unique within scope of the parent resource. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.CreateApiAsync(parent, api, apiId);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApiAsync(CreateApiRequest, CallSettings)
public virtual Task<Operation<Api, OperationMetadata>> CreateApiAsync(CreateApiRequest request, CallSettings callSettings = null)
Creates a new Api in a given project and location.
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 |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
CreateApiRequest request = new CreateApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ApiId = "",
Api = new gcav::Api(),
};
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.CreateApiAsync(request);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApiAsync(CreateApiRequest, CancellationToken)
public virtual Task<Operation<Api, OperationMetadata>> CreateApiAsync(CreateApiRequest request, CancellationToken cancellationToken)
Creates a new Api in a given project and location.
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 |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
CreateApiRequest request = new CreateApiRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
ApiId = "",
Api = new gcav::Api(),
};
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.CreateApiAsync(request);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApiAsync(String, Api, String, CallSettings)
public virtual Task<Operation<Api, OperationMetadata>> CreateApiAsync(string parent, Api api, string apiId, CallSettings callSettings = null)
Creates a new Api in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API, of the form:
|
api | Api Required. API resource. |
apiId | String Required. Identifier to assign to the API. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.CreateApiAsync(parent, api, apiId);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApiAsync(String, Api, String, CancellationToken)
public virtual Task<Operation<Api, OperationMetadata>> CreateApiAsync(string parent, Api api, string apiId, CancellationToken cancellationToken)
Creates a new Api in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API, of the form:
|
api | Api Required. API resource. |
apiId | String Required. Identifier to assign to the API. Must be unique within scope of the parent resource. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Api api = new gcav::Api();
string apiId = "";
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.CreateApiAsync(parent, api, apiId);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
CreateApiConfig(ApiName, ApiConfig, String, CallSettings)
public virtual Operation<ApiConfig, OperationMetadata> CreateApiConfig(ApiName parent, ApiConfig apiConfig, string apiConfigId, CallSettings callSettings = null)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. Parent resource of the API Config, of the form:
|
apiConfig | ApiConfig Required. API resource. |
apiConfigId | String Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<ApiConfig, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ApiName parent = ApiName.FromProjectApi("[PROJECT]", "[API]");
ApiConfig apiConfig = new ApiConfig();
string apiConfigId = "";
// Make the request
Operation<ApiConfig, OperationMetadata> response = apiGatewayServiceClient.CreateApiConfig(parent, apiConfig, apiConfigId);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfig(CreateApiConfigRequest, CallSettings)
public virtual Operation<ApiConfig, OperationMetadata> CreateApiConfig(CreateApiConfigRequest request, CallSettings callSettings = null)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateApiConfigRequest 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 |
Operation<ApiConfig, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
CreateApiConfigRequest request = new CreateApiConfigRequest
{
ParentAsApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
ApiConfigId = "",
ApiConfig = new ApiConfig(),
};
// Make the request
Operation<ApiConfig, OperationMetadata> response = apiGatewayServiceClient.CreateApiConfig(request);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfig(String, ApiConfig, String, CallSettings)
public virtual Operation<ApiConfig, OperationMetadata> CreateApiConfig(string parent, ApiConfig apiConfig, string apiConfigId, CallSettings callSettings = null)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API Config, of the form:
|
apiConfig | ApiConfig Required. API resource. |
apiConfigId | String Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<ApiConfig, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/global/apis/[API]";
ApiConfig apiConfig = new ApiConfig();
string apiConfigId = "";
// Make the request
Operation<ApiConfig, OperationMetadata> response = apiGatewayServiceClient.CreateApiConfig(parent, apiConfig, apiConfigId);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfigAsync(ApiName, ApiConfig, String, CallSettings)
public virtual Task<Operation<ApiConfig, OperationMetadata>> CreateApiConfigAsync(ApiName parent, ApiConfig apiConfig, string apiConfigId, CallSettings callSettings = null)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. Parent resource of the API Config, of the form:
|
apiConfig | ApiConfig Required. API resource. |
apiConfigId | String Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiName parent = ApiName.FromProjectApi("[PROJECT]", "[API]");
ApiConfig apiConfig = new ApiConfig();
string apiConfigId = "";
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.CreateApiConfigAsync(parent, apiConfig, apiConfigId);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfigAsync(ApiName, ApiConfig, String, CancellationToken)
public virtual Task<Operation<ApiConfig, OperationMetadata>> CreateApiConfigAsync(ApiName parent, ApiConfig apiConfig, string apiConfigId, CancellationToken cancellationToken)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. Parent resource of the API Config, of the form:
|
apiConfig | ApiConfig Required. API resource. |
apiConfigId | String Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiName parent = ApiName.FromProjectApi("[PROJECT]", "[API]");
ApiConfig apiConfig = new ApiConfig();
string apiConfigId = "";
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.CreateApiConfigAsync(parent, apiConfig, apiConfigId);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfigAsync(CreateApiConfigRequest, CallSettings)
public virtual Task<Operation<ApiConfig, OperationMetadata>> CreateApiConfigAsync(CreateApiConfigRequest request, CallSettings callSettings = null)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateApiConfigRequest 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<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
CreateApiConfigRequest request = new CreateApiConfigRequest
{
ParentAsApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
ApiConfigId = "",
ApiConfig = new ApiConfig(),
};
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.CreateApiConfigAsync(request);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfigAsync(CreateApiConfigRequest, CancellationToken)
public virtual Task<Operation<ApiConfig, OperationMetadata>> CreateApiConfigAsync(CreateApiConfigRequest request, CancellationToken cancellationToken)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateApiConfigRequest 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<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
CreateApiConfigRequest request = new CreateApiConfigRequest
{
ParentAsApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
ApiConfigId = "",
ApiConfig = new ApiConfig(),
};
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.CreateApiConfigAsync(request);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfigAsync(String, ApiConfig, String, CallSettings)
public virtual Task<Operation<ApiConfig, OperationMetadata>> CreateApiConfigAsync(string parent, ApiConfig apiConfig, string apiConfigId, CallSettings callSettings = null)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API Config, of the form:
|
apiConfig | ApiConfig Required. API resource. |
apiConfigId | String Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/global/apis/[API]";
ApiConfig apiConfig = new ApiConfig();
string apiConfigId = "";
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.CreateApiConfigAsync(parent, apiConfig, apiConfigId);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateApiConfigAsync(String, ApiConfig, String, CancellationToken)
public virtual Task<Operation<ApiConfig, OperationMetadata>> CreateApiConfigAsync(string parent, ApiConfig apiConfig, string apiConfigId, CancellationToken cancellationToken)
Creates a new ApiConfig in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API Config, of the form:
|
apiConfig | ApiConfig Required. API resource. |
apiConfigId | String Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/global/apis/[API]";
ApiConfig apiConfig = new ApiConfig();
string apiConfigId = "";
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.CreateApiConfigAsync(parent, apiConfig, apiConfigId);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
CreateAsync(CancellationToken)
public static Task<ApiGatewayServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a ApiGatewayServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ApiGatewayServiceClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<ApiGatewayServiceClient> | The task representing the created ApiGatewayServiceClient. |
CreateGateway(LocationName, Gateway, String, CallSettings)
public virtual Operation<Gateway, OperationMetadata> CreateGateway(LocationName parent, Gateway gateway, string gatewayId, CallSettings callSettings = null)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the Gateway, of the form:
|
gateway | Gateway Required. Gateway resource. |
gatewayId | String Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Gateway, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Gateway gateway = new Gateway();
string gatewayId = "";
// Make the request
Operation<Gateway, OperationMetadata> response = apiGatewayServiceClient.CreateGateway(parent, gateway, gatewayId);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGateway(CreateGatewayRequest, CallSettings)
public virtual Operation<Gateway, OperationMetadata> CreateGateway(CreateGatewayRequest request, CallSettings callSettings = null)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateGatewayRequest 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 |
Operation<Gateway, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
CreateGatewayRequest request = new CreateGatewayRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
GatewayId = "",
Gateway = new Gateway(),
};
// Make the request
Operation<Gateway, OperationMetadata> response = apiGatewayServiceClient.CreateGateway(request);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGateway(String, Gateway, String, CallSettings)
public virtual Operation<Gateway, OperationMetadata> CreateGateway(string parent, Gateway gateway, string gatewayId, CallSettings callSettings = null)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the Gateway, of the form:
|
gateway | Gateway Required. Gateway resource. |
gatewayId | String Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Gateway, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Gateway gateway = new Gateway();
string gatewayId = "";
// Make the request
Operation<Gateway, OperationMetadata> response = apiGatewayServiceClient.CreateGateway(parent, gateway, gatewayId);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceCreateGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGatewayAsync(LocationName, Gateway, String, CallSettings)
public virtual Task<Operation<Gateway, OperationMetadata>> CreateGatewayAsync(LocationName parent, Gateway gateway, string gatewayId, CallSettings callSettings = null)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the Gateway, of the form:
|
gateway | Gateway Required. Gateway resource. |
gatewayId | String Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Gateway gateway = new Gateway();
string gatewayId = "";
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.CreateGatewayAsync(parent, gateway, gatewayId);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGatewayAsync(LocationName, Gateway, String, CancellationToken)
public virtual Task<Operation<Gateway, OperationMetadata>> CreateGatewayAsync(LocationName parent, Gateway gateway, string gatewayId, CancellationToken cancellationToken)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the Gateway, of the form:
|
gateway | Gateway Required. Gateway resource. |
gatewayId | String Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Gateway gateway = new Gateway();
string gatewayId = "";
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.CreateGatewayAsync(parent, gateway, gatewayId);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGatewayAsync(CreateGatewayRequest, CallSettings)
public virtual Task<Operation<Gateway, OperationMetadata>> CreateGatewayAsync(CreateGatewayRequest request, CallSettings callSettings = null)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateGatewayRequest 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<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGatewayRequest request = new CreateGatewayRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
GatewayId = "",
Gateway = new Gateway(),
};
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.CreateGatewayAsync(request);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGatewayAsync(CreateGatewayRequest, CancellationToken)
public virtual Task<Operation<Gateway, OperationMetadata>> CreateGatewayAsync(CreateGatewayRequest request, CancellationToken cancellationToken)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateGatewayRequest 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<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGatewayRequest request = new CreateGatewayRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
GatewayId = "",
Gateway = new Gateway(),
};
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.CreateGatewayAsync(request);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGatewayAsync(String, Gateway, String, CallSettings)
public virtual Task<Operation<Gateway, OperationMetadata>> CreateGatewayAsync(string parent, Gateway gateway, string gatewayId, CallSettings callSettings = null)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the Gateway, of the form:
|
gateway | Gateway Required. Gateway resource. |
gatewayId | String Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Gateway gateway = new Gateway();
string gatewayId = "";
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.CreateGatewayAsync(parent, gateway, gatewayId);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
CreateGatewayAsync(String, Gateway, String, CancellationToken)
public virtual Task<Operation<Gateway, OperationMetadata>> CreateGatewayAsync(string parent, Gateway gateway, string gatewayId, CancellationToken cancellationToken)
Creates a new Gateway in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the Gateway, of the form:
|
gateway | Gateway Required. Gateway resource. |
gatewayId | String Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Gateway gateway = new Gateway();
string gatewayId = "";
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.CreateGatewayAsync(parent, gateway, gatewayId);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceCreateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
DeleteApi(ApiName, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteApi(ApiName name, CallSettings callSettings = null)
Deletes a single Api.
Parameters | |
---|---|
Name | Description |
name | ApiName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ApiName name = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteApi(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApi(DeleteApiRequest, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteApi(DeleteApiRequest request, CallSettings callSettings = null)
Deletes a single Api.
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 |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
DeleteApiRequest request = new DeleteApiRequest
{
ApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteApi(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApi(String, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteApi(string name, CallSettings callSettings = null)
Deletes a single Api.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteApi(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiAsync(ApiName, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiAsync(ApiName name, CallSettings callSettings = null)
Deletes a single Api.
Parameters | |
---|---|
Name | Description |
name | ApiName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiName name = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiAsync(ApiName, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiAsync(ApiName name, CancellationToken cancellationToken)
Deletes a single Api.
Parameters | |
---|---|
Name | Description |
name | ApiName Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiName name = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiAsync(DeleteApiRequest, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiAsync(DeleteApiRequest request, CallSettings callSettings = null)
Deletes a single Api.
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<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteApiRequest request = new DeleteApiRequest
{
ApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiAsync(DeleteApiRequest, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiAsync(DeleteApiRequest request, CancellationToken cancellationToken)
Deletes a single Api.
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<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteApiRequest request = new DeleteApiRequest
{
ApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiAsync(String, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiAsync(string name, CallSettings callSettings = null)
Deletes a single Api.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiAsync(String, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiAsync(string name, CancellationToken cancellationToken)
Deletes a single Api.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfig(ApiConfigName, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteApiConfig(ApiConfigName name, CallSettings callSettings = null)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | ApiConfigName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ApiConfigName name = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteApiConfig(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfig(DeleteApiConfigRequest, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteApiConfig(DeleteApiConfigRequest request, CallSettings callSettings = null)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | DeleteApiConfigRequest 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 |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
DeleteApiConfigRequest request = new DeleteApiConfigRequest
{
ApiConfigName = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteApiConfig(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfig(String, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteApiConfig(string name, CallSettings callSettings = null)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]/configs/[API_CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteApiConfig(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfigAsync(ApiConfigName, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiConfigAsync(ApiConfigName name, CallSettings callSettings = null)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | ApiConfigName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiConfigName name = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiConfigAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfigAsync(ApiConfigName, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiConfigAsync(ApiConfigName name, CancellationToken cancellationToken)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | ApiConfigName Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiConfigName name = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiConfigAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfigAsync(DeleteApiConfigRequest, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiConfigAsync(DeleteApiConfigRequest request, CallSettings callSettings = null)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | DeleteApiConfigRequest 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<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteApiConfigRequest request = new DeleteApiConfigRequest
{
ApiConfigName = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiConfigAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfigAsync(DeleteApiConfigRequest, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiConfigAsync(DeleteApiConfigRequest request, CancellationToken cancellationToken)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | DeleteApiConfigRequest 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<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteApiConfigRequest request = new DeleteApiConfigRequest
{
ApiConfigName = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiConfigAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfigAsync(String, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiConfigAsync(string name, CallSettings callSettings = null)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]/configs/[API_CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiConfigAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteApiConfigAsync(String, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteApiConfigAsync(string name, CancellationToken cancellationToken)
Deletes a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]/configs/[API_CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteApiConfigAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGateway(DeleteGatewayRequest, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteGateway(DeleteGatewayRequest request, CallSettings callSettings = null)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
request | DeleteGatewayRequest 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 |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
DeleteGatewayRequest request = new DeleteGatewayRequest
{
GatewayName = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteGateway(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGateway(GatewayName, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteGateway(GatewayName name, CallSettings callSettings = null)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
name | GatewayName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
GatewayName name = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]");
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteGateway(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGateway(String, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteGateway(string name, CallSettings callSettings = null)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gateways/[GATEWAY]";
// Make the request
Operation<Empty, OperationMetadata> response = apiGatewayServiceClient.DeleteGateway(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceDeleteGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGatewayAsync(DeleteGatewayRequest, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteGatewayAsync(DeleteGatewayRequest request, CallSettings callSettings = null)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
request | DeleteGatewayRequest 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<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGatewayRequest request = new DeleteGatewayRequest
{
GatewayName = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteGatewayAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGatewayAsync(DeleteGatewayRequest, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteGatewayAsync(DeleteGatewayRequest request, CancellationToken cancellationToken)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
request | DeleteGatewayRequest 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<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGatewayRequest request = new DeleteGatewayRequest
{
GatewayName = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteGatewayAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGatewayAsync(GatewayName, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteGatewayAsync(GatewayName name, CallSettings callSettings = null)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
name | GatewayName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GatewayName name = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]");
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteGatewayAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGatewayAsync(GatewayName, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteGatewayAsync(GatewayName name, CancellationToken cancellationToken)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
name | GatewayName Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GatewayName name = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]");
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteGatewayAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGatewayAsync(String, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteGatewayAsync(string name, CallSettings callSettings = null)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gateways/[GATEWAY]";
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteGatewayAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteGatewayAsync(String, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteGatewayAsync(string name, CancellationToken cancellationToken)
Deletes a single Gateway.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gateways/[GATEWAY]";
// Make the request
Operation<Empty, OperationMetadata> response = await apiGatewayServiceClient.DeleteGatewayAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceDeleteGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
GetApi(ApiName, CallSettings)
public virtual Api GetApi(ApiName name, CallSettings callSettings = null)
Gets details of a single Api.
Parameters | |
---|---|
Name | Description |
name | ApiName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ApiName name = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
gcav::Api response = apiGatewayServiceClient.GetApi(name);
GetApi(GetApiRequest, CallSettings)
public virtual Api GetApi(GetApiRequest request, CallSettings callSettings = null)
Gets details of a single Api.
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
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
GetApiRequest request = new GetApiRequest
{
ApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
};
// Make the request
gcav::Api response = apiGatewayServiceClient.GetApi(request);
GetApi(String, CallSettings)
public virtual Api GetApi(string name, CallSettings callSettings = null)
Gets details of a single Api.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Api | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
gcav::Api response = apiGatewayServiceClient.GetApi(name);
GetApiAsync(ApiName, CallSettings)
public virtual Task<Api> GetApiAsync(ApiName name, CallSettings callSettings = null)
Gets details of a single Api.
Parameters | |
---|---|
Name | Description |
name | ApiName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Api> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiName name = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
gcav::Api response = await apiGatewayServiceClient.GetApiAsync(name);
GetApiAsync(ApiName, CancellationToken)
public virtual Task<Api> GetApiAsync(ApiName name, CancellationToken cancellationToken)
Gets details of a single Api.
Parameters | |
---|---|
Name | Description |
name | ApiName Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Api> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiName name = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
gcav::Api response = await apiGatewayServiceClient.GetApiAsync(name);
GetApiAsync(GetApiRequest, CallSettings)
public virtual Task<Api> GetApiAsync(GetApiRequest request, CallSettings callSettings = null)
Gets details of a single Api.
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 |
Task<Api> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GetApiRequest request = new GetApiRequest
{
ApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
};
// Make the request
gcav::Api response = await apiGatewayServiceClient.GetApiAsync(request);
GetApiAsync(GetApiRequest, CancellationToken)
public virtual Task<Api> GetApiAsync(GetApiRequest request, CancellationToken cancellationToken)
Gets details of a single Api.
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 |
Task<Api> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GetApiRequest request = new GetApiRequest
{
ApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
};
// Make the request
gcav::Api response = await apiGatewayServiceClient.GetApiAsync(request);
GetApiAsync(String, CallSettings)
public virtual Task<Api> GetApiAsync(string name, CallSettings callSettings = null)
Gets details of a single Api.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Api> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
gcav::Api response = await apiGatewayServiceClient.GetApiAsync(name);
GetApiAsync(String, CancellationToken)
public virtual Task<Api> GetApiAsync(string name, CancellationToken cancellationToken)
Gets details of a single Api.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Api> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
gcav::Api response = await apiGatewayServiceClient.GetApiAsync(name);
GetApiConfig(ApiConfigName, CallSettings)
public virtual ApiConfig GetApiConfig(ApiConfigName name, CallSettings callSettings = null)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | ApiConfigName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ApiConfig | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ApiConfigName name = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]");
// Make the request
ApiConfig response = apiGatewayServiceClient.GetApiConfig(name);
GetApiConfig(GetApiConfigRequest, CallSettings)
public virtual ApiConfig GetApiConfig(GetApiConfigRequest request, CallSettings callSettings = null)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | GetApiConfigRequest 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 |
ApiConfig | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
GetApiConfigRequest request = new GetApiConfigRequest
{
ApiConfigName = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]"),
View = GetApiConfigRequest.Types.ConfigView.Unspecified,
};
// Make the request
ApiConfig response = apiGatewayServiceClient.GetApiConfig(request);
GetApiConfig(String, CallSettings)
public virtual ApiConfig GetApiConfig(string name, CallSettings callSettings = null)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ApiConfig | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]/configs/[API_CONFIG]";
// Make the request
ApiConfig response = apiGatewayServiceClient.GetApiConfig(name);
GetApiConfigAsync(ApiConfigName, CallSettings)
public virtual Task<ApiConfig> GetApiConfigAsync(ApiConfigName name, CallSettings callSettings = null)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | ApiConfigName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ApiConfig> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiConfigName name = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]");
// Make the request
ApiConfig response = await apiGatewayServiceClient.GetApiConfigAsync(name);
GetApiConfigAsync(ApiConfigName, CancellationToken)
public virtual Task<ApiConfig> GetApiConfigAsync(ApiConfigName name, CancellationToken cancellationToken)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | ApiConfigName Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<ApiConfig> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiConfigName name = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]");
// Make the request
ApiConfig response = await apiGatewayServiceClient.GetApiConfigAsync(name);
GetApiConfigAsync(GetApiConfigRequest, CallSettings)
public virtual Task<ApiConfig> GetApiConfigAsync(GetApiConfigRequest request, CallSettings callSettings = null)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | GetApiConfigRequest 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<ApiConfig> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GetApiConfigRequest request = new GetApiConfigRequest
{
ApiConfigName = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]"),
View = GetApiConfigRequest.Types.ConfigView.Unspecified,
};
// Make the request
ApiConfig response = await apiGatewayServiceClient.GetApiConfigAsync(request);
GetApiConfigAsync(GetApiConfigRequest, CancellationToken)
public virtual Task<ApiConfig> GetApiConfigAsync(GetApiConfigRequest request, CancellationToken cancellationToken)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | GetApiConfigRequest 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<ApiConfig> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GetApiConfigRequest request = new GetApiConfigRequest
{
ApiConfigName = ApiConfigName.FromProjectApiApiConfig("[PROJECT]", "[API]", "[API_CONFIG]"),
View = GetApiConfigRequest.Types.ConfigView.Unspecified,
};
// Make the request
ApiConfig response = await apiGatewayServiceClient.GetApiConfigAsync(request);
GetApiConfigAsync(String, CallSettings)
public virtual Task<ApiConfig> GetApiConfigAsync(string name, CallSettings callSettings = null)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ApiConfig> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]/configs/[API_CONFIG]";
// Make the request
ApiConfig response = await apiGatewayServiceClient.GetApiConfigAsync(name);
GetApiConfigAsync(String, CancellationToken)
public virtual Task<ApiConfig> GetApiConfigAsync(string name, CancellationToken cancellationToken)
Gets details of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<ApiConfig> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/global/apis/[API]/configs/[API_CONFIG]";
// Make the request
ApiConfig response = await apiGatewayServiceClient.GetApiConfigAsync(name);
GetGateway(GatewayName, CallSettings)
public virtual Gateway GetGateway(GatewayName name, CallSettings callSettings = null)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
name | GatewayName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Gateway | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
GatewayName name = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]");
// Make the request
Gateway response = apiGatewayServiceClient.GetGateway(name);
GetGateway(GetGatewayRequest, CallSettings)
public virtual Gateway GetGateway(GetGatewayRequest request, CallSettings callSettings = null)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
request | GetGatewayRequest 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 |
Gateway | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
GetGatewayRequest request = new GetGatewayRequest
{
GatewayName = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]"),
};
// Make the request
Gateway response = apiGatewayServiceClient.GetGateway(request);
GetGateway(String, CallSettings)
public virtual Gateway GetGateway(string name, CallSettings callSettings = null)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Gateway | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gateways/[GATEWAY]";
// Make the request
Gateway response = apiGatewayServiceClient.GetGateway(name);
GetGatewayAsync(GatewayName, CallSettings)
public virtual Task<Gateway> GetGatewayAsync(GatewayName name, CallSettings callSettings = null)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
name | GatewayName Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Gateway> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GatewayName name = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]");
// Make the request
Gateway response = await apiGatewayServiceClient.GetGatewayAsync(name);
GetGatewayAsync(GatewayName, CancellationToken)
public virtual Task<Gateway> GetGatewayAsync(GatewayName name, CancellationToken cancellationToken)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
name | GatewayName Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Gateway> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GatewayName name = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]");
// Make the request
Gateway response = await apiGatewayServiceClient.GetGatewayAsync(name);
GetGatewayAsync(GetGatewayRequest, CallSettings)
public virtual Task<Gateway> GetGatewayAsync(GetGatewayRequest request, CallSettings callSettings = null)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
request | GetGatewayRequest 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<Gateway> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GetGatewayRequest request = new GetGatewayRequest
{
GatewayName = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]"),
};
// Make the request
Gateway response = await apiGatewayServiceClient.GetGatewayAsync(request);
GetGatewayAsync(GetGatewayRequest, CancellationToken)
public virtual Task<Gateway> GetGatewayAsync(GetGatewayRequest request, CancellationToken cancellationToken)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
request | GetGatewayRequest 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<Gateway> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
GetGatewayRequest request = new GetGatewayRequest
{
GatewayName = GatewayName.FromProjectLocationGateway("[PROJECT]", "[LOCATION]", "[GATEWAY]"),
};
// Make the request
Gateway response = await apiGatewayServiceClient.GetGatewayAsync(request);
GetGatewayAsync(String, CallSettings)
public virtual Task<Gateway> GetGatewayAsync(string name, CallSettings callSettings = null)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Gateway> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gateways/[GATEWAY]";
// Make the request
Gateway response = await apiGatewayServiceClient.GetGatewayAsync(name);
GetGatewayAsync(String, CancellationToken)
public virtual Task<Gateway> GetGatewayAsync(string name, CancellationToken cancellationToken)
Gets details of a single Gateway.
Parameters | |
---|---|
Name | Description |
name | String Required. Resource name of the form:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Gateway> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gateways/[GATEWAY]";
// Make the request
Gateway response = await apiGatewayServiceClient.GetGatewayAsync(name);
ListApiConfigs(ApiName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigs(ApiName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists ApiConfigs in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. Parent resource of the API Config, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable sequence of ApiConfig resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ApiName parent = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
PagedEnumerable<ListApiConfigsResponse, ApiConfig> response = apiGatewayServiceClient.ListApiConfigs(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (ApiConfig 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 (ListApiConfigsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (ApiConfig 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<ApiConfig> 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 (ApiConfig 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;
ListApiConfigs(ListApiConfigsRequest, CallSettings)
public virtual PagedEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigs(ListApiConfigsRequest request, CallSettings callSettings = null)
Lists ApiConfigs in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListApiConfigsRequest 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 |
PagedEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable sequence of ApiConfig resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ListApiConfigsRequest request = new ListApiConfigsRequest
{
ParentAsApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedEnumerable<ListApiConfigsResponse, ApiConfig> response = apiGatewayServiceClient.ListApiConfigs(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (ApiConfig 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 (ListApiConfigsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (ApiConfig 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<ApiConfig> 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 (ApiConfig 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;
ListApiConfigs(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists ApiConfigs in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API Config, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable sequence of ApiConfig resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
PagedEnumerable<ListApiConfigsResponse, ApiConfig> response = apiGatewayServiceClient.ListApiConfigs(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (ApiConfig 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 (ListApiConfigsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (ApiConfig 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<ApiConfig> 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 (ApiConfig 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;
ListApiConfigsAsync(ApiName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigsAsync(ApiName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists ApiConfigs in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. Parent resource of the API Config, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable asynchronous sequence of ApiConfig resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiName parent = ApiName.FromProjectApi("[PROJECT]", "[API]");
// Make the request
PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> response = apiGatewayServiceClient.ListApiConfigsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ApiConfig 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((ListApiConfigsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (ApiConfig 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<ApiConfig> 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 (ApiConfig 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;
ListApiConfigsAsync(ListApiConfigsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigsAsync(ListApiConfigsRequest request, CallSettings callSettings = null)
Lists ApiConfigs in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListApiConfigsRequest 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 |
PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable asynchronous sequence of ApiConfig resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ListApiConfigsRequest request = new ListApiConfigsRequest
{
ParentAsApiName = ApiName.FromProjectApi("[PROJECT]", "[API]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> response = apiGatewayServiceClient.ListApiConfigsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ApiConfig 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((ListApiConfigsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (ApiConfig 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<ApiConfig> 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 (ApiConfig 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;
ListApiConfigsAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists ApiConfigs in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API Config, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable asynchronous sequence of ApiConfig resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/global/apis/[API]";
// Make the request
PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> response = apiGatewayServiceClient.ListApiConfigsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ApiConfig 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((ListApiConfigsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (ApiConfig 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<ApiConfig> 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 (ApiConfig 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, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListApisResponse, Api> ListApis(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Apis in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the API, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedEnumerable<ListApisResponse, Api> | A pageable sequence of Api resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListApisResponse, gcav::Api> response = apiGatewayServiceClient.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 (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)
Lists Apis in a given project and location.
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 |
PagedEnumerable<ListApisResponse, Api> | A pageable sequence of Api resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ListApisRequest request = new ListApisRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedEnumerable<ListApisResponse, gcav::Api> response = apiGatewayServiceClient.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 (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, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListApisResponse, Api> ListApis(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Apis in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedEnumerable<ListApisResponse, Api> | A pageable sequence of Api resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListApisResponse, gcav::Api> response = apiGatewayServiceClient.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 (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, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Apis in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the API, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedAsyncEnumerable<ListApisResponse, Api> | A pageable asynchronous sequence of Api resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListApisResponse, gcav::Api> response = apiGatewayServiceClient.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((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)
Lists Apis in a given project and location.
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 |
PagedAsyncEnumerable<ListApisResponse, Api> | A pageable asynchronous sequence of Api resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ListApisRequest request = new ListApisRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListApisResponse, gcav::Api> response = apiGatewayServiceClient.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((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, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Apis in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the API, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedAsyncEnumerable<ListApisResponse, Api> | A pageable asynchronous sequence of Api resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListApisResponse, gcav::Api> response = apiGatewayServiceClient.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((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;
ListGateways(LocationName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListGatewaysResponse, Gateway> ListGateways(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Gateways in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the Gateway, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedEnumerable<ListGatewaysResponse, Gateway> | A pageable sequence of Gateway resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListGatewaysResponse, Gateway> response = apiGatewayServiceClient.ListGateways(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Gateway 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 (ListGatewaysResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Gateway 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<Gateway> 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 (Gateway 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;
ListGateways(ListGatewaysRequest, CallSettings)
public virtual PagedEnumerable<ListGatewaysResponse, Gateway> ListGateways(ListGatewaysRequest request, CallSettings callSettings = null)
Lists Gateways in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListGatewaysRequest 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 |
PagedEnumerable<ListGatewaysResponse, Gateway> | A pageable sequence of Gateway resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ListGatewaysRequest request = new ListGatewaysRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedEnumerable<ListGatewaysResponse, Gateway> response = apiGatewayServiceClient.ListGateways(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Gateway 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 (ListGatewaysResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Gateway 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<Gateway> 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 (Gateway 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;
ListGateways(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListGatewaysResponse, Gateway> ListGateways(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Gateways in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the Gateway, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedEnumerable<ListGatewaysResponse, Gateway> | A pageable sequence of Gateway resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListGatewaysResponse, Gateway> response = apiGatewayServiceClient.ListGateways(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Gateway 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 (ListGatewaysResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Gateway 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<Gateway> 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 (Gateway 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;
ListGatewaysAsync(LocationName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListGatewaysResponse, Gateway> ListGatewaysAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Gateways in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. Parent resource of the Gateway, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedAsyncEnumerable<ListGatewaysResponse, Gateway> | A pageable asynchronous sequence of Gateway resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListGatewaysResponse, Gateway> response = apiGatewayServiceClient.ListGatewaysAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Gateway 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((ListGatewaysResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Gateway 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<Gateway> 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 (Gateway 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;
ListGatewaysAsync(ListGatewaysRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListGatewaysResponse, Gateway> ListGatewaysAsync(ListGatewaysRequest request, CallSettings callSettings = null)
Lists Gateways in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListGatewaysRequest 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 |
PagedAsyncEnumerable<ListGatewaysResponse, Gateway> | A pageable asynchronous sequence of Gateway resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ListGatewaysRequest request = new ListGatewaysRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListGatewaysResponse, Gateway> response = apiGatewayServiceClient.ListGatewaysAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Gateway 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((ListGatewaysResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Gateway 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<Gateway> 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 (Gateway 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;
ListGatewaysAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListGatewaysResponse, Gateway> ListGatewaysAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists Gateways in a given project and location.
Parameters | |
---|---|
Name | Description |
parent | String Required. Parent resource of the Gateway, of the form:
|
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedAsyncEnumerable<ListGatewaysResponse, Gateway> | A pageable asynchronous sequence of Gateway resources. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListGatewaysResponse, Gateway> response = apiGatewayServiceClient.ListGatewaysAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Gateway 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((ListGatewaysResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Gateway 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<Gateway> 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 (Gateway 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;
PollOnceCreateApi(String, CallSettings)
public virtual Operation<Api, OperationMetadata> PollOnceCreateApi(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of CreateApi
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Api, OperationMetadata> | The result of polling the operation. |
PollOnceCreateApiAsync(String, CallSettings)
public virtual Task<Operation<Api, OperationMetadata>> PollOnceCreateApiAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
CreateApi
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceCreateApiConfig(String, CallSettings)
public virtual Operation<ApiConfig, OperationMetadata> PollOnceCreateApiConfig(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of CreateApiConfig
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<ApiConfig, OperationMetadata> | The result of polling the operation. |
PollOnceCreateApiConfigAsync(String, CallSettings)
public virtual Task<Operation<ApiConfig, OperationMetadata>> PollOnceCreateApiConfigAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
CreateApiConfig
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceCreateGateway(String, CallSettings)
public virtual Operation<Gateway, OperationMetadata> PollOnceCreateGateway(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of CreateGateway
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Gateway, OperationMetadata> | The result of polling the operation. |
PollOnceCreateGatewayAsync(String, CallSettings)
public virtual Task<Operation<Gateway, OperationMetadata>> PollOnceCreateGatewayAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
CreateGateway
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceDeleteApi(String, CallSettings)
public virtual Operation<Empty, OperationMetadata> PollOnceDeleteApi(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of DeleteApi
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The result of polling the operation. |
PollOnceDeleteApiAsync(String, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteApiAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
DeleteApi
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceDeleteApiConfig(String, CallSettings)
public virtual Operation<Empty, OperationMetadata> PollOnceDeleteApiConfig(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of DeleteApiConfig
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The result of polling the operation. |
PollOnceDeleteApiConfigAsync(String, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteApiConfigAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
DeleteApiConfig
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceDeleteGateway(String, CallSettings)
public virtual Operation<Empty, OperationMetadata> PollOnceDeleteGateway(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of DeleteGateway
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The result of polling the operation. |
PollOnceDeleteGatewayAsync(String, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteGatewayAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
DeleteGateway
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceUpdateApi(String, CallSettings)
public virtual Operation<Api, OperationMetadata> PollOnceUpdateApi(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of UpdateApi
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Api, OperationMetadata> | The result of polling the operation. |
PollOnceUpdateApiAsync(String, CallSettings)
public virtual Task<Operation<Api, OperationMetadata>> PollOnceUpdateApiAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
UpdateApi
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceUpdateApiConfig(String, CallSettings)
public virtual Operation<ApiConfig, OperationMetadata> PollOnceUpdateApiConfig(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of UpdateApiConfig
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<ApiConfig, OperationMetadata> | The result of polling the operation. |
PollOnceUpdateApiConfigAsync(String, CallSettings)
public virtual Task<Operation<ApiConfig, OperationMetadata>> PollOnceUpdateApiConfigAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
UpdateApiConfig
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A task representing the result of polling the operation. |
PollOnceUpdateGateway(String, CallSettings)
public virtual Operation<Gateway, OperationMetadata> PollOnceUpdateGateway(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of UpdateGateway
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Gateway, OperationMetadata> | The result of polling the operation. |
PollOnceUpdateGatewayAsync(String, CallSettings)
public virtual Task<Operation<Gateway, OperationMetadata>> PollOnceUpdateGatewayAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
UpdateGateway
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A task representing the result of polling the operation. |
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 Operation<Api, OperationMetadata> UpdateApi(Api api, FieldMask updateMask, CallSettings callSettings = null)
Updates the parameters of a single Api.
Parameters | |
---|---|
Name | Description |
api | Api Required. API resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Api, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
gcav::Api api = new gcav::Api();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcav::Api, OperationMetadata> response = apiGatewayServiceClient.UpdateApi(api, updateMask);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceUpdateApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
UpdateApi(UpdateApiRequest, CallSettings)
public virtual Operation<Api, OperationMetadata> UpdateApi(UpdateApiRequest request, CallSettings callSettings = null)
Updates the parameters of a single Api.
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 |
Operation<Api, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
UpdateApiRequest request = new UpdateApiRequest
{
UpdateMask = new FieldMask(),
Api = new gcav::Api(),
};
// Make the request
Operation<gcav::Api, OperationMetadata> response = apiGatewayServiceClient.UpdateApi(request);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceUpdateApi(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
UpdateApiAsync(Api, FieldMask, CallSettings)
public virtual Task<Operation<Api, OperationMetadata>> UpdateApiAsync(Api api, FieldMask updateMask, CallSettings callSettings = null)
Updates the parameters of a single Api.
Parameters | |
---|---|
Name | Description |
api | Api Required. API resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::Api api = new gcav::Api();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiAsync(api, updateMask);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
UpdateApiAsync(Api, FieldMask, CancellationToken)
public virtual Task<Operation<Api, OperationMetadata>> UpdateApiAsync(Api api, FieldMask updateMask, CancellationToken cancellationToken)
Updates the parameters of a single Api.
Parameters | |
---|---|
Name | Description |
api | Api Required. API resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::Api api = new gcav::Api();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiAsync(api, updateMask);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
UpdateApiAsync(UpdateApiRequest, CallSettings)
public virtual Task<Operation<Api, OperationMetadata>> UpdateApiAsync(UpdateApiRequest request, CallSettings callSettings = null)
Updates the parameters of a single Api.
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 |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateApiRequest request = new UpdateApiRequest
{
UpdateMask = new FieldMask(),
Api = new gcav::Api(),
};
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiAsync(request);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
UpdateApiAsync(UpdateApiRequest, CancellationToken)
public virtual Task<Operation<Api, OperationMetadata>> UpdateApiAsync(UpdateApiRequest request, CancellationToken cancellationToken)
Updates the parameters of a single Api.
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 |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateApiRequest request = new UpdateApiRequest
{
UpdateMask = new FieldMask(),
Api = new gcav::Api(),
};
// Make the request
Operation<gcav::Api, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiAsync(request);
// Poll until the returned long-running operation is complete
Operation<gcav::Api, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Api result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Api, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
gcav::Api retrievedResult = retrievedResponse.Result;
}
UpdateApiConfig(ApiConfig, FieldMask, CallSettings)
public virtual Operation<ApiConfig, OperationMetadata> UpdateApiConfig(ApiConfig apiConfig, FieldMask updateMask, CallSettings callSettings = null)
Updates the parameters of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
apiConfig | ApiConfig Required. API Config resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<ApiConfig, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
ApiConfig apiConfig = new ApiConfig();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<ApiConfig, OperationMetadata> response = apiGatewayServiceClient.UpdateApiConfig(apiConfig, updateMask);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceUpdateApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
UpdateApiConfig(UpdateApiConfigRequest, CallSettings)
public virtual Operation<ApiConfig, OperationMetadata> UpdateApiConfig(UpdateApiConfigRequest request, CallSettings callSettings = null)
Updates the parameters of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | UpdateApiConfigRequest 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 |
Operation<ApiConfig, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
UpdateApiConfigRequest request = new UpdateApiConfigRequest
{
UpdateMask = new FieldMask(),
ApiConfig = new ApiConfig(),
};
// Make the request
Operation<ApiConfig, OperationMetadata> response = apiGatewayServiceClient.UpdateApiConfig(request);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceUpdateApiConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
UpdateApiConfigAsync(ApiConfig, FieldMask, CallSettings)
public virtual Task<Operation<ApiConfig, OperationMetadata>> UpdateApiConfigAsync(ApiConfig apiConfig, FieldMask updateMask, CallSettings callSettings = null)
Updates the parameters of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
apiConfig | ApiConfig Required. API Config resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiConfig apiConfig = new ApiConfig();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiConfigAsync(apiConfig, updateMask);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
UpdateApiConfigAsync(ApiConfig, FieldMask, CancellationToken)
public virtual Task<Operation<ApiConfig, OperationMetadata>> UpdateApiConfigAsync(ApiConfig apiConfig, FieldMask updateMask, CancellationToken cancellationToken)
Updates the parameters of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
apiConfig | ApiConfig Required. API Config resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
ApiConfig apiConfig = new ApiConfig();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiConfigAsync(apiConfig, updateMask);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
UpdateApiConfigAsync(UpdateApiConfigRequest, CallSettings)
public virtual Task<Operation<ApiConfig, OperationMetadata>> UpdateApiConfigAsync(UpdateApiConfigRequest request, CallSettings callSettings = null)
Updates the parameters of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | UpdateApiConfigRequest 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<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateApiConfigRequest request = new UpdateApiConfigRequest
{
UpdateMask = new FieldMask(),
ApiConfig = new ApiConfig(),
};
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiConfigAsync(request);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
UpdateApiConfigAsync(UpdateApiConfigRequest, CancellationToken)
public virtual Task<Operation<ApiConfig, OperationMetadata>> UpdateApiConfigAsync(UpdateApiConfigRequest request, CancellationToken cancellationToken)
Updates the parameters of a single ApiConfig.
Parameters | |
---|---|
Name | Description |
request | UpdateApiConfigRequest 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<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateApiConfigRequest request = new UpdateApiConfigRequest
{
UpdateMask = new FieldMask(),
ApiConfig = new ApiConfig(),
};
// Make the request
Operation<ApiConfig, OperationMetadata> response = await apiGatewayServiceClient.UpdateApiConfigAsync(request);
// Poll until the returned long-running operation is complete
Operation<ApiConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ApiConfig result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ApiConfig, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateApiConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ApiConfig retrievedResult = retrievedResponse.Result;
}
UpdateGateway(Gateway, FieldMask, CallSettings)
public virtual Operation<Gateway, OperationMetadata> UpdateGateway(Gateway gateway, FieldMask updateMask, CallSettings callSettings = null)
Updates the parameters of a single Gateway.
Parameters | |
---|---|
Name | Description |
gateway | Gateway Required. Gateway resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Gateway, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
Gateway gateway = new Gateway();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Gateway, OperationMetadata> response = apiGatewayServiceClient.UpdateGateway(gateway, updateMask);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceUpdateGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
UpdateGateway(UpdateGatewayRequest, CallSettings)
public virtual Operation<Gateway, OperationMetadata> UpdateGateway(UpdateGatewayRequest request, CallSettings callSettings = null)
Updates the parameters of a single Gateway.
Parameters | |
---|---|
Name | Description |
request | UpdateGatewayRequest 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 |
Operation<Gateway, OperationMetadata> | The RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.Create();
// Initialize request argument(s)
UpdateGatewayRequest request = new UpdateGatewayRequest
{
UpdateMask = new FieldMask(),
Gateway = new Gateway(),
};
// Make the request
Operation<Gateway, OperationMetadata> response = apiGatewayServiceClient.UpdateGateway(request);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = apiGatewayServiceClient.PollOnceUpdateGateway(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
UpdateGatewayAsync(Gateway, FieldMask, CallSettings)
public virtual Task<Operation<Gateway, OperationMetadata>> UpdateGatewayAsync(Gateway gateway, FieldMask updateMask, CallSettings callSettings = null)
Updates the parameters of a single Gateway.
Parameters | |
---|---|
Name | Description |
gateway | Gateway Required. Gateway resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
Gateway gateway = new Gateway();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.UpdateGatewayAsync(gateway, updateMask);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
UpdateGatewayAsync(Gateway, FieldMask, CancellationToken)
public virtual Task<Operation<Gateway, OperationMetadata>> UpdateGatewayAsync(Gateway gateway, FieldMask updateMask, CancellationToken cancellationToken)
Updates the parameters of a single Gateway.
Parameters | |
---|---|
Name | Description |
gateway | Gateway Required. Gateway resource. |
updateMask | FieldMask Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
Gateway gateway = new Gateway();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.UpdateGatewayAsync(gateway, updateMask);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
UpdateGatewayAsync(UpdateGatewayRequest, CallSettings)
public virtual Task<Operation<Gateway, OperationMetadata>> UpdateGatewayAsync(UpdateGatewayRequest request, CallSettings callSettings = null)
Updates the parameters of a single Gateway.
Parameters | |
---|---|
Name | Description |
request | UpdateGatewayRequest 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<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGatewayRequest request = new UpdateGatewayRequest
{
UpdateMask = new FieldMask(),
Gateway = new Gateway(),
};
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.UpdateGatewayAsync(request);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}
UpdateGatewayAsync(UpdateGatewayRequest, CancellationToken)
public virtual Task<Operation<Gateway, OperationMetadata>> UpdateGatewayAsync(UpdateGatewayRequest request, CancellationToken cancellationToken)
Updates the parameters of a single Gateway.
Parameters | |
---|---|
Name | Description |
request | UpdateGatewayRequest 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<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
// Create client
ApiGatewayServiceClient apiGatewayServiceClient = await ApiGatewayServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGatewayRequest request = new UpdateGatewayRequest
{
UpdateMask = new FieldMask(),
Gateway = new Gateway(),
};
// Make the request
Operation<Gateway, OperationMetadata> response = await apiGatewayServiceClient.UpdateGatewayAsync(request);
// Poll until the returned long-running operation is complete
Operation<Gateway, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Gateway result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Gateway, OperationMetadata> retrievedResponse = await apiGatewayServiceClient.PollOnceUpdateGatewayAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Gateway retrievedResult = retrievedResponse.Result;
}