Service Management v1 API - Class ServiceManager.ServiceManagerClient (2.3.0)

public class ServiceManager.ServiceManagerClient : ClientBase<ServiceManager.ServiceManagerClient>

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

Client for ServiceManager

Inheritance

object > ClientBase > ClientBaseServiceManagerServiceManagerClient > ServiceManager.ServiceManagerClient

Namespace

Google.Cloud.ServiceManagement.V1

Assembly

Google.Cloud.ServiceManagement.V1.dll

Constructors

ServiceManagerClient()

protected ServiceManagerClient()

Protected parameterless constructor to allow creation of test doubles.

ServiceManagerClient(CallInvoker)

public ServiceManagerClient(CallInvoker callInvoker)

Creates a new client for ServiceManager that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ServiceManagerClient(ChannelBase)

public ServiceManagerClient(ChannelBase channel)

Creates a new client for ServiceManager

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ServiceManagerClient(ClientBaseConfiguration)

protected ServiceManagerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateService(CreateServiceRequest, CallOptions)

public virtual Operation CreateService(CreateServiceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateService(CreateServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateService(CreateServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateServiceAsync(CreateServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateServiceAsync(CreateServiceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateServiceAsync(CreateServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateServiceAsync(CreateServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateServiceConfig(CreateServiceConfigRequest, CallOptions)

public virtual Service CreateServiceConfig(CreateServiceConfigRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Service

The response received from the server.

CreateServiceConfig(CreateServiceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Service CreateServiceConfig(CreateServiceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Service

The response received from the server.

CreateServiceConfigAsync(CreateServiceConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Service> CreateServiceConfigAsync(CreateServiceConfigRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallService

The call object.

CreateServiceConfigAsync(CreateServiceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Service> CreateServiceConfigAsync(CreateServiceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallService

The call object.

CreateServiceRollout(CreateServiceRolloutRequest, CallOptions)

public virtual Operation CreateServiceRollout(CreateServiceRolloutRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateServiceRollout(CreateServiceRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateServiceRollout(CreateServiceRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateServiceRolloutAsync(CreateServiceRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateServiceRolloutAsync(CreateServiceRolloutRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateServiceRolloutAsync(CreateServiceRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateServiceRolloutAsync(CreateServiceRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteService(DeleteServiceRequest, CallOptions)

public virtual Operation DeleteService(DeleteServiceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteService(DeleteServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteService(DeleteServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteServiceAsync(DeleteServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteServiceAsync(DeleteServiceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteServiceAsync(DeleteServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteServiceAsync(DeleteServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

GenerateConfigReport(GenerateConfigReportRequest, CallOptions)

public virtual GenerateConfigReportResponse GenerateConfigReport(GenerateConfigReportRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
GenerateConfigReportResponse

The response received from the server.

GenerateConfigReport(GenerateConfigReportRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateConfigReportResponse GenerateConfigReport(GenerateConfigReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
GenerateConfigReportResponse

The response received from the server.

GenerateConfigReportAsync(GenerateConfigReportRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateConfigReportResponse> GenerateConfigReportAsync(GenerateConfigReportRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallGenerateConfigReportResponse

The call object.

GenerateConfigReportAsync(GenerateConfigReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateConfigReportResponse> GenerateConfigReportAsync(GenerateConfigReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallGenerateConfigReportResponse

The call object.

GetService(GetServiceRequest, CallOptions)

public virtual ManagedService GetService(GetServiceRequest request, CallOptions options)

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

Parameters
Name Description
request GetServiceRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ManagedService

The response received from the server.

GetService(GetServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual ManagedService GetService(GetServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetServiceRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ManagedService

The response received from the server.

GetServiceAsync(GetServiceRequest, CallOptions)

public virtual AsyncUnaryCall<ManagedService> GetServiceAsync(GetServiceRequest request, CallOptions options)

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

Parameters
Name Description
request GetServiceRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallManagedService

The call object.

GetServiceAsync(GetServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ManagedService> GetServiceAsync(GetServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetServiceRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallManagedService

The call object.

GetServiceConfig(GetServiceConfigRequest, CallOptions)

public virtual Service GetServiceConfig(GetServiceConfigRequest request, CallOptions options)

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

Parameters
Name Description
request GetServiceConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Service

The response received from the server.

GetServiceConfig(GetServiceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Service GetServiceConfig(GetServiceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetServiceConfigRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Service

The response received from the server.

GetServiceConfigAsync(GetServiceConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Service> GetServiceConfigAsync(GetServiceConfigRequest request, CallOptions options)

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

Parameters
Name Description
request GetServiceConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallService

The call object.

GetServiceConfigAsync(GetServiceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Service> GetServiceConfigAsync(GetServiceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetServiceConfigRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallService

The call object.

GetServiceRollout(GetServiceRolloutRequest, CallOptions)

public virtual Rollout GetServiceRollout(GetServiceRolloutRequest request, CallOptions options)

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

Parameters
Name Description
request GetServiceRolloutRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Rollout

The response received from the server.

GetServiceRollout(GetServiceRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Rollout GetServiceRollout(GetServiceRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetServiceRolloutRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Rollout

The response received from the server.

GetServiceRolloutAsync(GetServiceRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Rollout> GetServiceRolloutAsync(GetServiceRolloutRequest request, CallOptions options)

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

Parameters
Name Description
request GetServiceRolloutRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRollout

The call object.

GetServiceRolloutAsync(GetServiceRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Rollout> GetServiceRolloutAsync(GetServiceRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetServiceRolloutRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRollout

The call object.

ListServiceConfigs(ListServiceConfigsRequest, CallOptions)

public virtual ListServiceConfigsResponse ListServiceConfigs(ListServiceConfigsRequest request, CallOptions options)

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

Parameters
Name Description
request ListServiceConfigsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListServiceConfigsResponse

The response received from the server.

ListServiceConfigs(ListServiceConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListServiceConfigsResponse ListServiceConfigs(ListServiceConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListServiceConfigsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListServiceConfigsResponse

The response received from the server.

ListServiceConfigsAsync(ListServiceConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListServiceConfigsResponse> ListServiceConfigsAsync(ListServiceConfigsRequest request, CallOptions options)

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

Parameters
Name Description
request ListServiceConfigsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListServiceConfigsResponse

The call object.

ListServiceConfigsAsync(ListServiceConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListServiceConfigsResponse> ListServiceConfigsAsync(ListServiceConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListServiceConfigsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListServiceConfigsResponse

The call object.

ListServiceRollouts(ListServiceRolloutsRequest, CallOptions)

public virtual ListServiceRolloutsResponse ListServiceRollouts(ListServiceRolloutsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListServiceRolloutsResponse

The response received from the server.

ListServiceRollouts(ListServiceRolloutsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListServiceRolloutsResponse ListServiceRollouts(ListServiceRolloutsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListServiceRolloutsResponse

The response received from the server.

ListServiceRolloutsAsync(ListServiceRolloutsRequest, CallOptions)

public virtual AsyncUnaryCall<ListServiceRolloutsResponse> ListServiceRolloutsAsync(ListServiceRolloutsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListServiceRolloutsResponse

The call object.

ListServiceRolloutsAsync(ListServiceRolloutsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListServiceRolloutsResponse> ListServiceRolloutsAsync(ListServiceRolloutsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListServiceRolloutsResponse

The call object.

ListServices(ListServicesRequest, CallOptions)

public virtual ListServicesResponse ListServices(ListServicesRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListServicesResponse

The response received from the server.

ListServices(ListServicesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListServicesResponse ListServices(ListServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListServicesResponse

The response received from the server.

ListServicesAsync(ListServicesRequest, CallOptions)

public virtual AsyncUnaryCall<ListServicesResponse> ListServicesAsync(ListServicesRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListServicesResponse

The call object.

ListServicesAsync(ListServicesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListServicesResponse> ListServicesAsync(ListServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListServicesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ServiceManager.ServiceManagerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ServiceManagerServiceManagerClient
Overrides

SubmitConfigSource(SubmitConfigSourceRequest, CallOptions)

public virtual Operation SubmitConfigSource(SubmitConfigSourceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

SubmitConfigSource(SubmitConfigSourceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SubmitConfigSource(SubmitConfigSourceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

SubmitConfigSourceAsync(SubmitConfigSourceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SubmitConfigSourceAsync(SubmitConfigSourceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

SubmitConfigSourceAsync(SubmitConfigSourceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SubmitConfigSourceAsync(SubmitConfigSourceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UndeleteService(UndeleteServiceRequest, CallOptions)

public virtual Operation UndeleteService(UndeleteServiceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UndeleteService(UndeleteServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UndeleteService(UndeleteServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UndeleteServiceAsync(UndeleteServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UndeleteServiceAsync(UndeleteServiceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UndeleteServiceAsync(UndeleteServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UndeleteServiceAsync(UndeleteServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.