Service Management v1 API - Class ServiceManagerClientImpl (2.4.0) 

public sealed class ServiceManagerClientImpl : ServiceManagerClient

Reference documentation and code samples for the Service Management v1 API class ServiceManagerClientImpl.

ServiceManager client wrapper implementation, for convenient use.

Inheritance

object > ServiceManagerClient > ServiceManagerClientImpl

Namespace

Google.Cloud.ServiceManagement.V1

Assembly

Google.Cloud.ServiceManagement.V1.dll

Remarks

Google Service Management API

Constructors

ServiceManagerClientImpl(ServiceManagerClient, ServiceManagerSettings, ILogger)

public ServiceManagerClientImpl(ServiceManager.ServiceManagerClient grpcClient, ServiceManagerSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient ServiceManagerServiceManagerClient

The underlying gRPC client.
settings ServiceManagerSettings

The base ServiceManagerSettings 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

CreateServiceRolloutOperationsClient

public override OperationsClient CreateServiceRolloutOperationsClient { get; }

The long-running operations client for CreateServiceRollout.

Property Value
Type Description
OperationsClient
Overrides

DeleteServiceOperationsClient

public override OperationsClient DeleteServiceOperationsClient { get; }

The long-running operations client for DeleteService.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ServiceManager.ServiceManagerClient GrpcClient { get; }

The underlying gRPC ServiceManager client

Property Value
Type Description
ServiceManagerServiceManagerClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

SubmitConfigSourceOperationsClient

public override OperationsClient SubmitConfigSourceOperationsClient { get; }

The long-running operations client for SubmitConfigSource.

Property Value
Type Description
OperationsClient
Overrides

UndeleteServiceOperationsClient

public override OperationsClient UndeleteServiceOperationsClient { get; }

The long-running operations client for UndeleteService.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateService(CreateServiceRequest, CallSettings)

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

Creates a new managed service.

A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.

One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.

Operation<response: ManagedService>

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
OperationManagedServiceOperationMetadata

The RPC response.
Overrides

CreateServiceAsync(CreateServiceRequest, CallSettings)

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

Creates a new managed service.

A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.

One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.

Operation<response: ManagedService>

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
TaskOperationManagedServiceOperationMetadata

A Task containing the RPC response.
Overrides

CreateServiceConfig(CreateServiceConfigRequest, CallSettings)

public override Service CreateServiceConfig(CreateServiceConfigRequest request, CallSettings callSettings = null)

Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].

Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.

Parameters
Name Description
request CreateServiceConfigRequest

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

CreateServiceConfigAsync(CreateServiceConfigRequest, CallSettings)

public override Task<Service> CreateServiceConfigAsync(CreateServiceConfigRequest request, CallSettings callSettings = null)

Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].

Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.

Parameters
Name Description
request CreateServiceConfigRequest

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

CreateServiceRollout(CreateServiceRolloutRequest, CallSettings)

public override Operation<Rollout, OperationMetadata> CreateServiceRollout(CreateServiceRolloutRequest request, CallSettings callSettings = null)

Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.

Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.

Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.

Operation<response: Rollout>

Parameters
Name Description
request CreateServiceRolloutRequest

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
OperationRolloutOperationMetadata

The RPC response.
Overrides

CreateServiceRolloutAsync(CreateServiceRolloutRequest, CallSettings)

public override Task<Operation<Rollout, OperationMetadata>> CreateServiceRolloutAsync(CreateServiceRolloutRequest request, CallSettings callSettings = null)

Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.

Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.

Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.

Operation<response: Rollout>

Parameters
Name Description
request CreateServiceRolloutRequest

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
TaskOperationRolloutOperationMetadata

A Task containing the RPC response.
Overrides

DeleteService(DeleteServiceRequest, CallSettings)

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

Deletes a managed service. This method will change the service to the Soft-Delete state for 30 days. Within this period, service producers may call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service. After 30 days, the service will be permanently deleted.

Operation<response: google.protobuf.Empty>

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
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteServiceAsync(DeleteServiceRequest, CallSettings)

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

Deletes a managed service. This method will change the service to the Soft-Delete state for 30 days. Within this period, service producers may call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service. After 30 days, the service will be permanently deleted.

Operation<response: google.protobuf.Empty>

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
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GenerateConfigReport(GenerateConfigReportRequest, CallSettings)

public override GenerateConfigReportResponse GenerateConfigReport(GenerateConfigReportRequest request, CallSettings callSettings = null)

Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value

If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.

Parameters
Name Description
request GenerateConfigReportRequest

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
GenerateConfigReportResponse

The RPC response.
Overrides

GenerateConfigReportAsync(GenerateConfigReportRequest, CallSettings)

public override Task<GenerateConfigReportResponse> GenerateConfigReportAsync(GenerateConfigReportRequest request, CallSettings callSettings = null)

Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value

If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.

Parameters
Name Description
request GenerateConfigReportRequest

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
TaskGenerateConfigReportResponse

A Task containing the RPC response.
Overrides

GetService(GetServiceRequest, CallSettings)

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

Gets a managed service. Authentication is required unless the service is public.

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
ManagedService

The RPC response.
Overrides

GetServiceAsync(GetServiceRequest, CallSettings)

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

Gets a managed service. Authentication is required unless the service is public.

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
TaskManagedService

A Task containing the RPC response.
Overrides

GetServiceConfig(GetServiceConfigRequest, CallSettings)

public override Service GetServiceConfig(GetServiceConfigRequest request, CallSettings callSettings = null)

Gets a service configuration (version) for a managed service.

Parameters
Name Description
request GetServiceConfigRequest

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

GetServiceConfigAsync(GetServiceConfigRequest, CallSettings)

public override Task<Service> GetServiceConfigAsync(GetServiceConfigRequest request, CallSettings callSettings = null)

Gets a service configuration (version) for a managed service.

Parameters
Name Description
request GetServiceConfigRequest

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

GetServiceRollout(GetServiceRolloutRequest, CallSettings)

public override Rollout GetServiceRollout(GetServiceRolloutRequest request, CallSettings callSettings = null)

Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].

Parameters
Name Description
request GetServiceRolloutRequest

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
Rollout

The RPC response.
Overrides

GetServiceRolloutAsync(GetServiceRolloutRequest, CallSettings)

public override Task<Rollout> GetServiceRolloutAsync(GetServiceRolloutRequest request, CallSettings callSettings = null)

Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].

Parameters
Name Description
request GetServiceRolloutRequest

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
TaskRollout

A Task containing the RPC response.
Overrides

ListServiceConfigs(ListServiceConfigsRequest, CallSettings)

public override PagedEnumerable<ListServiceConfigsResponse, Service> ListServiceConfigs(ListServiceConfigsRequest request, CallSettings callSettings = null)

Lists the history of the service configuration for a managed service, from the newest to the oldest.

Parameters
Name Description
request ListServiceConfigsRequest

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
PagedEnumerableListServiceConfigsResponseService

A pageable sequence of Service resources.
Overrides

ListServiceConfigsAsync(ListServiceConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListServiceConfigsResponse, Service> ListServiceConfigsAsync(ListServiceConfigsRequest request, CallSettings callSettings = null)

Lists the history of the service configuration for a managed service, from the newest to the oldest.

Parameters
Name Description
request ListServiceConfigsRequest

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
PagedAsyncEnumerableListServiceConfigsResponseService

A pageable asynchronous sequence of Service resources.
Overrides

ListServiceRollouts(ListServiceRolloutsRequest, CallSettings)

public override PagedEnumerable<ListServiceRolloutsResponse, Rollout> ListServiceRollouts(ListServiceRolloutsRequest request, CallSettings callSettings = null)

Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.

Parameters
Name Description
request ListServiceRolloutsRequest

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
PagedEnumerableListServiceRolloutsResponseRollout

A pageable sequence of Rollout resources.
Overrides

ListServiceRolloutsAsync(ListServiceRolloutsRequest, CallSettings)

public override PagedAsyncEnumerable<ListServiceRolloutsResponse, Rollout> ListServiceRolloutsAsync(ListServiceRolloutsRequest request, CallSettings callSettings = null)

Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.

Parameters
Name Description
request ListServiceRolloutsRequest

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
PagedAsyncEnumerableListServiceRolloutsResponseRollout

A pageable asynchronous sequence of Rollout resources.
Overrides

ListServices(ListServicesRequest, CallSettings)

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

Lists managed services.

Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.

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
PagedEnumerableListServicesResponseManagedService

A pageable sequence of ManagedService resources.
Overrides

ListServicesAsync(ListServicesRequest, CallSettings)

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

Lists managed services.

Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.

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
PagedAsyncEnumerableListServicesResponseManagedService

A pageable asynchronous sequence of ManagedService resources.
Overrides

SubmitConfigSource(SubmitConfigSourceRequest, CallSettings)

public override Operation<SubmitConfigSourceResponse, OperationMetadata> SubmitConfigSource(SubmitConfigSourceRequest request, CallSettings callSettings = null)

Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].

Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.

Operation<response: SubmitConfigSourceResponse>

Parameters
Name Description
request SubmitConfigSourceRequest

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
OperationSubmitConfigSourceResponseOperationMetadata

The RPC response.
Overrides

SubmitConfigSourceAsync(SubmitConfigSourceRequest, CallSettings)

public override Task<Operation<SubmitConfigSourceResponse, OperationMetadata>> SubmitConfigSourceAsync(SubmitConfigSourceRequest request, CallSettings callSettings = null)

Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].

Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.

Operation<response: SubmitConfigSourceResponse>

Parameters
Name Description
request SubmitConfigSourceRequest

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
TaskOperationSubmitConfigSourceResponseOperationMetadata

A Task containing the RPC response.
Overrides

UndeleteService(UndeleteServiceRequest, CallSettings)

public override Operation<UndeleteServiceResponse, OperationMetadata> UndeleteService(UndeleteServiceRequest request, CallSettings callSettings = null)

Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.

Operation<response: UndeleteServiceResponse>

Parameters
Name Description
request UndeleteServiceRequest

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
OperationUndeleteServiceResponseOperationMetadata

The RPC response.
Overrides

UndeleteServiceAsync(UndeleteServiceRequest, CallSettings)

public override Task<Operation<UndeleteServiceResponse, OperationMetadata>> UndeleteServiceAsync(UndeleteServiceRequest request, CallSettings callSettings = null)

Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.

Operation<response: UndeleteServiceResponse>

Parameters
Name Description
request UndeleteServiceRequest

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
TaskOperationUndeleteServiceResponseOperationMetadata

A Task containing the RPC response.
Overrides