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

Version 2.3.0

• 2.4.0 (latest)
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0

[BindServiceMethod(typeof(ServiceManager), "BindService")]
public abstract class ServiceManager.ServiceManagerBase

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

Base class for server-side implementations of ServiceManager

Inheritance

object > ServiceManager.ServiceManagerBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ServiceManagement.V1

Assembly

Google.Cloud.ServiceManagement.V1.dll

Methods

CreateService(CreateServiceRequest, ServerCallContext)

public virtual Task<Operation> CreateService(CreateServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateServiceConfig(CreateServiceConfigRequest, ServerCallContext)

public virtual Task<Service> CreateServiceConfig(CreateServiceConfigRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskService	The response to send back to the client (wrapped by a task).

CreateServiceRollout(CreateServiceRolloutRequest, ServerCallContext)

public virtual Task<Operation> CreateServiceRollout(CreateServiceRolloutRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteService(DeleteServiceRequest, ServerCallContext)

public virtual Task<Operation> DeleteService(DeleteServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GenerateConfigReport(GenerateConfigReportRequest, ServerCallContext)

public virtual Task<GenerateConfigReportResponse> GenerateConfigReport(GenerateConfigReportRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateConfigReportResponse	The response to send back to the client (wrapped by a task).

GetService(GetServiceRequest, ServerCallContext)

public virtual Task<ManagedService> GetService(GetServiceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskManagedService	The response to send back to the client (wrapped by a task).

GetServiceConfig(GetServiceConfigRequest, ServerCallContext)

public virtual Task<Service> GetServiceConfig(GetServiceConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetServiceConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskService	The response to send back to the client (wrapped by a task).

GetServiceRollout(GetServiceRolloutRequest, ServerCallContext)

public virtual Task<Rollout> GetServiceRollout(GetServiceRolloutRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetServiceRolloutRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRollout	The response to send back to the client (wrapped by a task).

ListServiceConfigs(ListServiceConfigsRequest, ServerCallContext)

public virtual Task<ListServiceConfigsResponse> ListServiceConfigs(ListServiceConfigsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListServiceConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListServiceConfigsResponse	The response to send back to the client (wrapped by a task).

ListServiceRollouts(ListServiceRolloutsRequest, ServerCallContext)

public virtual Task<ListServiceRolloutsResponse> ListServiceRollouts(ListServiceRolloutsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListServiceRolloutsResponse	The response to send back to the client (wrapped by a task).

ListServices(ListServicesRequest, ServerCallContext)

public virtual Task<ListServicesResponse> ListServices(ListServicesRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListServicesResponse	The response to send back to the client (wrapped by a task).

SubmitConfigSource(SubmitConfigSourceRequest, ServerCallContext)

public virtual Task<Operation> SubmitConfigSource(SubmitConfigSourceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UndeleteService(UndeleteServiceRequest, ServerCallContext)

public virtual Task<Operation> UndeleteService(UndeleteServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).