Class ServiceManagerClientImpl (1.1.0)

public sealed class ServiceManagerClientImpl : ServiceManagerClient

ServiceManager client wrapper implementation, for convenient use.

Inheritance

Object > ServiceManagerClient > ServiceManagerClientImpl

Namespace

Google.Cloud.ServiceManagement.V1

Assembly

Google.Cloud.ServiceManagement.V1.dll

Remarks

Constructors

ServiceManagerClientImpl(ServiceManager.ServiceManagerClient, ServiceManagerSettings)

public ServiceManagerClientImpl(ServiceManager.ServiceManagerClient grpcClient, ServiceManagerSettings settings)

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

Parameters
NameDescription
grpcClientServiceManager.ServiceManagerClient

The underlying gRPC client.

settingsServiceManagerSettings

The base ServiceManagerSettings used within this client.

Properties

CreateServiceOperationsClient

public override OperationsClient CreateServiceOperationsClient { get; }

The long-running operations client for CreateService.

Property Value
TypeDescription
Google.LongRunning.OperationsClient
Overrides

CreateServiceRolloutOperationsClient

public override OperationsClient CreateServiceRolloutOperationsClient { get; }

The long-running operations client for CreateServiceRollout.

Property Value
TypeDescription
Google.LongRunning.OperationsClient
Overrides

DeleteServiceOperationsClient

public override OperationsClient DeleteServiceOperationsClient { get; }

The long-running operations client for DeleteService.

Property Value
TypeDescription
Google.LongRunning.OperationsClient
Overrides

DisableServiceOperationsClient

public override OperationsClient DisableServiceOperationsClient { get; }

The long-running operations client for DisableService.

Property Value
TypeDescription
Google.LongRunning.OperationsClient
Overrides

EnableServiceOperationsClient

public override OperationsClient EnableServiceOperationsClient { get; }

The long-running operations client for EnableService.

Property Value
TypeDescription
Google.LongRunning.OperationsClient
Overrides

GrpcClient

public override ServiceManager.ServiceManagerClient GrpcClient { get; }

The underlying gRPC ServiceManager client

Property Value
TypeDescription
ServiceManager.ServiceManagerClient
Overrides

SubmitConfigSourceOperationsClient

public override OperationsClient SubmitConfigSourceOperationsClient { get; }

The long-running operations client for SubmitConfigSource.

Property Value
TypeDescription
Google.LongRunning.OperationsClient
Overrides

UndeleteServiceOperationsClient

public override OperationsClient UndeleteServiceOperationsClient { get; }

The long-running operations client for UndeleteService.

Property Value
TypeDescription
Google.LongRunning.OperationsClient
Overrides

Methods

CreateService(CreateServiceRequest, CallSettings)

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

Creates a new managed service. Please note one producer project can own no more than 20 services.

Operation&lt;response: ManagedService&gt;

Parameters
NameDescription
requestCreateServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<ManagedService, OperationMetadata>

The RPC response.

Overrides

CreateServiceAsync(CreateServiceRequest, CallSettings)

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

Creates a new managed service. Please note one producer project can own no more than 20 services.

Operation&lt;response: ManagedService&gt;

Parameters
NameDescription
requestCreateServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<ManagedService, OperationMetadata>>

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
NameDescription
requestCreateServiceConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestCreateServiceConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Service>

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&lt;response: Rollout&gt;

Parameters
NameDescription
requestCreateServiceRolloutRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Rollout, OperationMetadata>

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&lt;response: Rollout&gt;

Parameters
NameDescription
requestCreateServiceRolloutRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Rollout, OperationMetadata>>

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&lt;response: google.protobuf.Empty&gt;

Parameters
NameDescription
requestDeleteServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<Empty, OperationMetadata>

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&lt;response: google.protobuf.Empty&gt;

Parameters
NameDescription
requestDeleteServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Overrides

DisableService(DisableServiceRequest, CallSettings)

public override Operation<DisableServiceResponse, OperationMetadata> DisableService(DisableServiceRequest request, CallSettings callSettings = null)

Disables a [service][google.api.servicemanagement.v1.ManagedService] for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks.

Operation&lt;response: DisableServiceResponse&gt;

Parameters
NameDescription
requestDisableServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<DisableServiceResponse, OperationMetadata>

The RPC response.

Overrides

DisableServiceAsync(DisableServiceRequest, CallSettings)

public override Task<Operation<DisableServiceResponse, OperationMetadata>> DisableServiceAsync(DisableServiceRequest request, CallSettings callSettings = null)

Disables a [service][google.api.servicemanagement.v1.ManagedService] for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks.

Operation&lt;response: DisableServiceResponse&gt;

Parameters
NameDescription
requestDisableServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<DisableServiceResponse, OperationMetadata>>

A Task containing the RPC response.

Overrides

EnableService(EnableServiceRequest, CallSettings)

public override Operation<EnableServiceResponse, OperationMetadata> EnableService(EnableServiceRequest request, CallSettings callSettings = null)

Enables a [service][google.api.servicemanagement.v1.ManagedService] for a project, so it can be used for the project. See Cloud Auth Guide for more information.

Operation&lt;response: EnableServiceResponse&gt;

Parameters
NameDescription
requestEnableServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<EnableServiceResponse, OperationMetadata>

The RPC response.

Overrides

EnableServiceAsync(EnableServiceRequest, CallSettings)

public override Task<Operation<EnableServiceResponse, OperationMetadata>> EnableServiceAsync(EnableServiceRequest request, CallSettings callSettings = null)

Enables a [service][google.api.servicemanagement.v1.ManagedService] for a project, so it can be used for the project. See Cloud Auth Guide for more information.

Operation&lt;response: EnableServiceResponse&gt;

Parameters
NameDescription
requestEnableServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<EnableServiceResponse, OperationMetadata>>

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
NameDescription
requestGenerateConfigReportRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGenerateConfigReportRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GenerateConfigReportResponse>

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
NameDescription
requestGetServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ManagedService>

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
NameDescription
requestGetServiceConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetServiceConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Service>

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
NameDescription
requestGetServiceRolloutRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetServiceRolloutRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Rollout>

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
NameDescription
requestListServiceConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListServiceConfigsResponse, Service>

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
NameDescription
requestListServiceConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListServiceConfigsResponse, Service>

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
NameDescription
requestListServiceRolloutsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListServiceRolloutsResponse, Rollout>

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
NameDescription
requestListServiceRolloutsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListServiceRolloutsResponse, Rollout>

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.

BETA: If the caller specifies the consumer_id, it returns only the services enabled on the consumer. The consumer_id must have the format of "project:{PROJECT-ID}".

Parameters
NameDescription
requestListServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListServicesResponse, ManagedService>

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.

BETA: If the caller specifies the consumer_id, it returns only the services enabled on the consumer. The consumer_id must have the format of "project:{PROJECT-ID}".

Parameters
NameDescription
requestListServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListServicesResponse, ManagedService>

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&lt;response: SubmitConfigSourceResponse&gt;

Parameters
NameDescription
requestSubmitConfigSourceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<SubmitConfigSourceResponse, OperationMetadata>

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&lt;response: SubmitConfigSourceResponse&gt;

Parameters
NameDescription
requestSubmitConfigSourceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<SubmitConfigSourceResponse, OperationMetadata>>

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&lt;response: UndeleteServiceResponse&gt;

Parameters
NameDescription
requestUndeleteServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.LongRunning.Operation<UndeleteServiceResponse, OperationMetadata>

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&lt;response: UndeleteServiceResponse&gt;

Parameters
NameDescription
requestUndeleteServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Google.LongRunning.Operation<UndeleteServiceResponse, OperationMetadata>>

A Task containing the RPC response.

Overrides