Service Usage v1 API - Class ServiceUsage.ServiceUsageBase (2.3.0)

[BindServiceMethod(typeof(ServiceUsage), "BindService")]
public abstract class ServiceUsage.ServiceUsageBase

Reference documentation and code samples for the Service Usage v1 API class ServiceUsage.ServiceUsageBase.

Base class for server-side implementations of ServiceUsage

Inheritance

object > ServiceUsage.ServiceUsageBase

Namespace

Google.Cloud.ServiceUsage.V1

Assembly

Google.Cloud.ServiceUsage.V1.dll

Methods

BatchEnableServices(BatchEnableServicesRequest, ServerCallContext)

public virtual Task<Operation> BatchEnableServices(BatchEnableServicesRequest request, ServerCallContext context)

Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service, use the EnableService method instead.

Parameters
NameDescription
requestBatchEnableServicesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

BatchGetServices(BatchGetServicesRequest, ServerCallContext)

public virtual Task<BatchGetServicesResponse> BatchGetServices(BatchGetServicesRequest request, ServerCallContext context)

Returns the service configurations and enabled states for a given list of services.

Parameters
NameDescription
requestBatchGetServicesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskBatchGetServicesResponse

The response to send back to the client (wrapped by a task).

DisableService(DisableServiceRequest, ServerCallContext)

public virtual Task<Operation> DisableService(DisableServiceRequest request, ServerCallContext context)

Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks.

It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a FAILED_PRECONDITION status if the target service is not currently enabled.

Parameters
NameDescription
requestDisableServiceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

EnableService(EnableServiceRequest, ServerCallContext)

public virtual Task<Operation> EnableService(EnableServiceRequest request, ServerCallContext context)

Enable a service so that it can be used with a project.

Parameters
NameDescription
requestEnableServiceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

GetService(GetServiceRequest, ServerCallContext)

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

Returns the service configuration and enabled state for a given service.

Parameters
NameDescription
requestGetServiceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskService

The response to send back to the client (wrapped by a task).

ListServices(ListServicesRequest, ServerCallContext)

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

List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the servicemanagement.services.bind permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.

WARNING: If you need to query enabled services frequently or across an organization, you should use Cloud Asset Inventory API, which provides higher throughput and richer filtering capability.

Parameters
NameDescription
requestListServicesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListServicesResponse

The response to send back to the client (wrapped by a task).