Cloud Run Admin v2 API - Class ServicesClientImpl (2.12.0)

Version latest

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0-beta02

public sealed class ServicesClientImpl : ServicesClient

Reference documentation and code samples for the Cloud Run Admin v2 API class ServicesClientImpl.

Services client wrapper implementation, for convenient use.

Inheritance

object > ServicesClient > ServicesClientImpl

Inherited Members

ServicesClient.DefaultEndpoint

ServicesClient.DefaultScopes

ServicesClient.ServiceMetadata

ServicesClient.CreateAsync(CancellationToken)

ServicesClient.Create()

ServicesClient.ShutdownDefaultChannelsAsync()

ServicesClient.CreateServiceAsync(CreateServiceRequest, CancellationToken)

ServicesClient.PollOnceCreateService(string, CallSettings)

ServicesClient.PollOnceCreateServiceAsync(string, CallSettings)

ServicesClient.CreateService(string, Service, string, CallSettings)

ServicesClient.CreateServiceAsync(string, Service, string, CallSettings)

ServicesClient.CreateServiceAsync(string, Service, string, CancellationToken)

ServicesClient.CreateService(LocationName, Service, string, CallSettings)

ServicesClient.CreateServiceAsync(LocationName, Service, string, CallSettings)

ServicesClient.CreateServiceAsync(LocationName, Service, string, CancellationToken)

ServicesClient.GetServiceAsync(GetServiceRequest, CancellationToken)

ServicesClient.GetService(string, CallSettings)

ServicesClient.GetServiceAsync(string, CallSettings)

ServicesClient.GetServiceAsync(string, CancellationToken)

ServicesClient.GetService(ServiceName, CallSettings)

ServicesClient.GetServiceAsync(ServiceName, CallSettings)

ServicesClient.GetServiceAsync(ServiceName, CancellationToken)

ServicesClient.ListServices(string, string, int?, CallSettings)

ServicesClient.ListServicesAsync(string, string, int?, CallSettings)

ServicesClient.ListServices(LocationName, string, int?, CallSettings)

ServicesClient.ListServicesAsync(LocationName, string, int?, CallSettings)

ServicesClient.UpdateServiceAsync(UpdateServiceRequest, CancellationToken)

ServicesClient.PollOnceUpdateService(string, CallSettings)

ServicesClient.PollOnceUpdateServiceAsync(string, CallSettings)

ServicesClient.UpdateService(Service, CallSettings)

ServicesClient.UpdateServiceAsync(Service, CallSettings)

ServicesClient.UpdateServiceAsync(Service, CancellationToken)

ServicesClient.UpdateService(Service, FieldMask, CallSettings)

ServicesClient.UpdateServiceAsync(Service, FieldMask, CallSettings)

ServicesClient.UpdateServiceAsync(Service, FieldMask, CancellationToken)

ServicesClient.DeleteServiceAsync(DeleteServiceRequest, CancellationToken)

ServicesClient.PollOnceDeleteService(string, CallSettings)

ServicesClient.PollOnceDeleteServiceAsync(string, CallSettings)

ServicesClient.DeleteService(string, CallSettings)

ServicesClient.DeleteServiceAsync(string, CallSettings)

ServicesClient.DeleteServiceAsync(string, CancellationToken)

ServicesClient.DeleteService(ServiceName, CallSettings)

ServicesClient.DeleteServiceAsync(ServiceName, CallSettings)

ServicesClient.DeleteServiceAsync(ServiceName, CancellationToken)

ServicesClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

ServicesClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

ServicesClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Remarks

Cloud Run Service Control Plane API

Constructors

ServicesClientImpl(ServicesClient, ServicesSettings, ILogger)

public ServicesClientImpl(Services.ServicesClient grpcClient, ServicesSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	ServicesServicesClient The underlying gRPC client.
settings	ServicesSettings The base ServicesSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateServiceOperationsClient

public override OperationsClient CreateServiceOperationsClient { get; }

The long-running operations client for CreateService.

Property Value
Type	Description
OperationsClient

Overrides

ServicesClient.CreateServiceOperationsClient

DeleteServiceOperationsClient

public override OperationsClient DeleteServiceOperationsClient { get; }

The long-running operations client for DeleteService.

Property Value
Type	Description
OperationsClient

Overrides

ServicesClient.DeleteServiceOperationsClient

GrpcClient

public override Services.ServicesClient GrpcClient { get; }

The underlying gRPC Services client

Property Value
Type	Description
ServicesServicesClient

Overrides

ServicesClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

ServicesClient.LocationsClient

UpdateServiceOperationsClient

public override OperationsClient UpdateServiceOperationsClient { get; }

The long-running operations client for UpdateService.

Property Value
Type	Description
OperationsClient

Overrides

ServicesClient.UpdateServiceOperationsClient

Methods

CreateService(CreateServiceRequest, CallSettings)

public override Operation<Service, Service> CreateService(CreateServiceRequest request, CallSettings callSettings = null)

Creates a new Service in a given project and location.

Parameters
Name	Description
request	CreateServiceRequest 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
OperationServiceService	The RPC response.

Overrides

ServicesClient.CreateService(CreateServiceRequest, CallSettings)

CreateServiceAsync(CreateServiceRequest, CallSettings)

public override Task<Operation<Service, Service>> CreateServiceAsync(CreateServiceRequest request, CallSettings callSettings = null)

Creates a new Service in a given project and location.

Parameters
Name	Description
request	CreateServiceRequest 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
TaskOperationServiceService	A Task containing the RPC response.

Overrides

ServicesClient.CreateServiceAsync(CreateServiceRequest, CallSettings)

DeleteService(DeleteServiceRequest, CallSettings)

public override Operation<Service, Service> DeleteService(DeleteServiceRequest request, CallSettings callSettings = null)

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

Parameters
Name	Description
request	DeleteServiceRequest 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
OperationServiceService	The RPC response.

Overrides

ServicesClient.DeleteService(DeleteServiceRequest, CallSettings)

DeleteServiceAsync(DeleteServiceRequest, CallSettings)

public override Task<Operation<Service, Service>> DeleteServiceAsync(DeleteServiceRequest request, CallSettings callSettings = null)

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

Parameters
Name	Description
request	DeleteServiceRequest 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
TaskOperationServiceService	A Task containing the RPC response.

Overrides

ServicesClient.DeleteServiceAsync(DeleteServiceRequest, CallSettings)

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.

Parameters
Name	Description
request	GetIamPolicyRequest 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
Policy	The RPC response.

Overrides

ServicesClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.

Parameters
Name	Description
request	GetIamPolicyRequest 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
TaskPolicy	A Task containing the RPC response.

Overrides

ServicesClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

GetService(GetServiceRequest, CallSettings)

public override Service GetService(GetServiceRequest request, CallSettings callSettings = null)

Gets information about a Service.

Parameters
Name	Description
request	GetServiceRequest 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
Service	The RPC response.

Overrides

ServicesClient.GetService(GetServiceRequest, CallSettings)

GetServiceAsync(GetServiceRequest, CallSettings)

public override Task<Service> GetServiceAsync(GetServiceRequest request, CallSettings callSettings = null)

Gets information about a Service.

Parameters
Name	Description
request	GetServiceRequest 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
TaskService	A Task containing the RPC response.

Overrides

ServicesClient.GetServiceAsync(GetServiceRequest, CallSettings)

ListServices(ListServicesRequest, CallSettings)

public override PagedEnumerable<ListServicesResponse, Service> ListServices(ListServicesRequest request, CallSettings callSettings = null)

Lists Services. Results are sorted by creation time, descending.

Parameters
Name	Description
request	ListServicesRequest 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
PagedEnumerableListServicesResponseService	A pageable sequence of Service resources.

Overrides

ServicesClient.ListServices(ListServicesRequest, CallSettings)

ListServicesAsync(ListServicesRequest, CallSettings)

public override PagedAsyncEnumerable<ListServicesResponse, Service> ListServicesAsync(ListServicesRequest request, CallSettings callSettings = null)

Lists Services. Results are sorted by creation time, descending.

Parameters
Name	Description
request	ListServicesRequest 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
PagedAsyncEnumerableListServicesResponseService	A pageable asynchronous sequence of Service resources.

Overrides

ServicesClient.ListServicesAsync(ListServicesRequest, CallSettings)

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

Parameters
Name	Description
request	SetIamPolicyRequest 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
Policy	The RPC response.

Overrides

ServicesClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

Parameters
Name	Description
request	SetIamPolicyRequest 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
TaskPolicy	A Task containing the RPC response.

Overrides

ServicesClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Parameters
Name	Description
request	TestIamPermissionsRequest 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
TestIamPermissionsResponse	The RPC response.

Overrides

ServicesClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Parameters
Name	Description
request	TestIamPermissionsRequest 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
TaskTestIamPermissionsResponse	A Task containing the RPC response.

Overrides

ServicesClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

UpdateService(UpdateServiceRequest, CallSettings)

public override Operation<Service, Service> UpdateService(UpdateServiceRequest request, CallSettings callSettings = null)

Updates a Service.

Parameters
Name	Description
request	UpdateServiceRequest 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
OperationServiceService	The RPC response.

Overrides

ServicesClient.UpdateService(UpdateServiceRequest, CallSettings)

UpdateServiceAsync(UpdateServiceRequest, CallSettings)

public override Task<Operation<Service, Service>> UpdateServiceAsync(UpdateServiceRequest request, CallSettings callSettings = null)

Updates a Service.

Parameters
Name	Description
request	UpdateServiceRequest 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
TaskOperationServiceService	A Task containing the RPC response.

Overrides

ServicesClient.UpdateServiceAsync(UpdateServiceRequest, CallSettings)