Class ServiceUsageGrpc.ServiceUsageBlockingStub (2.46.0)

public static final class ServiceUsageGrpc.ServiceUsageBlockingStub extends AbstractBlockingStub<ServiceUsageGrpc.ServiceUsageBlockingStub>

A stub to allow clients to do synchronous rpc calls to service ServiceUsage.

Service Usage API

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ServiceUsageGrpc.ServiceUsageBlockingStub

Methods

batchEnableServices(BatchEnableServicesRequest request) (deprecated)

public Operation batchEnableServices(BatchEnableServicesRequest request)

Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation response type: google.protobuf.Empty

Parameter
Name Description
request BatchEnableServicesRequest
Returns
Type Description
Operation

build(Channel channel, CallOptions callOptions)

protected ServiceUsageGrpc.ServiceUsageBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
ServiceUsageGrpc.ServiceUsageBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAdminOverride(CreateAdminOverrideRequest request)

public Operation createAdminOverride(CreateAdminOverrideRequest request)

Creates an admin override. An admin override is applied by an administrator of a parent folder or parent organization of the consumer receiving the override. An admin override is intended to limit the amount of quota the consumer can use out of the total quota pool allocated to all children of the folder or organization.

Parameter
Name Description
request CreateAdminOverrideRequest
Returns
Type Description
Operation

createConsumerOverride(CreateConsumerOverrideRequest request)

public Operation createConsumerOverride(CreateConsumerOverrideRequest request)

Creates a consumer override. A consumer override is applied to the consumer on its own authority to limit its own quota usage. Consumer overrides cannot be used to grant more quota than would be allowed by admin overrides, producer overrides, or the default limit of the service.

Parameter
Name Description
request CreateConsumerOverrideRequest
Returns
Type Description
Operation

deleteAdminOverride(DeleteAdminOverrideRequest request)

public Operation deleteAdminOverride(DeleteAdminOverrideRequest request)

Deletes an admin override.

Parameter
Name Description
request DeleteAdminOverrideRequest
Returns
Type Description
Operation

deleteConsumerOverride(DeleteConsumerOverrideRequest request)

public Operation deleteConsumerOverride(DeleteConsumerOverrideRequest request)

Deletes a consumer override.

Parameter
Name Description
request DeleteConsumerOverrideRequest
Returns
Type Description
Operation

disableService(DisableServiceRequest request) (deprecated)

public Operation disableService(DisableServiceRequest request)

Disables 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. Operation response type: google.protobuf.Empty

Parameter
Name Description
request DisableServiceRequest
Returns
Type Description
Operation

enableService(EnableServiceRequest request) (deprecated)

public Operation enableService(EnableServiceRequest request)

Enables a service so that it can be used with a project. Operation response type: google.protobuf.Empty

Parameter
Name Description
request EnableServiceRequest
Returns
Type Description
Operation

generateServiceIdentity(GenerateServiceIdentityRequest request)

public Operation generateServiceIdentity(GenerateServiceIdentityRequest request)

Generates service identity for service.

Parameter
Name Description
request GenerateServiceIdentityRequest
Returns
Type Description
Operation

getConsumerQuotaLimit(GetConsumerQuotaLimitRequest request)

public ConsumerQuotaLimit getConsumerQuotaLimit(GetConsumerQuotaLimitRequest request)

Retrieves a summary of quota information for a specific quota limit.

Parameter
Name Description
request GetConsumerQuotaLimitRequest
Returns
Type Description
ConsumerQuotaLimit

getConsumerQuotaMetric(GetConsumerQuotaMetricRequest request)

public ConsumerQuotaMetric getConsumerQuotaMetric(GetConsumerQuotaMetricRequest request)

Retrieves a summary of quota information for a specific quota metric

Parameter
Name Description
request GetConsumerQuotaMetricRequest
Returns
Type Description
ConsumerQuotaMetric

getService(GetServiceRequest request) (deprecated)

public Service getService(GetServiceRequest request)

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

Parameter
Name Description
request GetServiceRequest
Returns
Type Description
Service

importAdminOverrides(ImportAdminOverridesRequest request)

public Operation importAdminOverrides(ImportAdminOverridesRequest request)

Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

Parameter
Name Description
request ImportAdminOverridesRequest
Returns
Type Description
Operation

importConsumerOverrides(ImportConsumerOverridesRequest request)

public Operation importConsumerOverrides(ImportConsumerOverridesRequest request)

Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

Parameter
Name Description
request ImportConsumerOverridesRequest
Returns
Type Description
Operation

listAdminOverrides(ListAdminOverridesRequest request)

public ListAdminOverridesResponse listAdminOverrides(ListAdminOverridesRequest request)

Lists all admin overrides on this limit.

Parameter
Name Description
request ListAdminOverridesRequest
Returns
Type Description
ListAdminOverridesResponse

listConsumerOverrides(ListConsumerOverridesRequest request)

public ListConsumerOverridesResponse listConsumerOverrides(ListConsumerOverridesRequest request)

Lists all consumer overrides on this limit.

Parameter
Name Description
request ListConsumerOverridesRequest
Returns
Type Description
ListConsumerOverridesResponse

listConsumerQuotaMetrics(ListConsumerQuotaMetricsRequest request)

public ListConsumerQuotaMetricsResponse listConsumerQuotaMetrics(ListConsumerQuotaMetricsRequest request)

Retrieves a summary of all quota information visible to the service consumer, organized by service metric. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.

Parameter
Name Description
request ListConsumerQuotaMetricsRequest
Returns
Type Description
ListConsumerQuotaMetricsResponse

listServices(ListServicesRequest request) (deprecated)

public ListServicesResponse listServices(ListServicesRequest request)

Lists 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.

Parameter
Name Description
request ListServicesRequest
Returns
Type Description
ListServicesResponse

updateAdminOverride(UpdateAdminOverrideRequest request)

public Operation updateAdminOverride(UpdateAdminOverrideRequest request)

Updates an admin override.

Parameter
Name Description
request UpdateAdminOverrideRequest
Returns
Type Description
Operation

updateConsumerOverride(UpdateConsumerOverrideRequest request)

public Operation updateConsumerOverride(UpdateConsumerOverrideRequest request)

Updates a consumer override.

Parameter
Name Description
request UpdateConsumerOverrideRequest
Returns
Type Description
Operation