Class ServiceUsageGrpc.ServiceUsageFutureStub (2.3.5)

Stay organized with collections Save and categorize content based on your preferences.
public static final class ServiceUsageGrpc.ServiceUsageFutureStub extends AbstractFutureStub<ServiceUsageGrpc.ServiceUsageFutureStub>

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ServiceUsageGrpc.ServiceUsageFutureStub

Methods

batchEnableServices(BatchEnableServicesRequest request)

public ListenableFuture<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
NameDescription
requestBatchEnableServicesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

build(Channel channel, CallOptions callOptions)

protected ServiceUsageGrpc.ServiceUsageFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ServiceUsageGrpc.ServiceUsageFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAdminOverride(CreateAdminOverrideRequest request)

public ListenableFuture<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
NameDescription
requestCreateAdminOverrideRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

createConsumerOverride(CreateConsumerOverrideRequest request)

public ListenableFuture<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
NameDescription
requestCreateConsumerOverrideRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteAdminOverride(DeleteAdminOverrideRequest request)

public ListenableFuture<Operation> deleteAdminOverride(DeleteAdminOverrideRequest request)

Deletes an admin override.

Parameter
NameDescription
requestDeleteAdminOverrideRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteConsumerOverride(DeleteConsumerOverrideRequest request)

public ListenableFuture<Operation> deleteConsumerOverride(DeleteConsumerOverrideRequest request)

Deletes a consumer override.

Parameter
NameDescription
requestDeleteConsumerOverrideRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

disableService(DisableServiceRequest request)

public ListenableFuture<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
NameDescription
requestDisableServiceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

enableService(EnableServiceRequest request)

public ListenableFuture<Operation> enableService(EnableServiceRequest request)

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

Parameter
NameDescription
requestEnableServiceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

generateServiceIdentity(GenerateServiceIdentityRequest request)

public ListenableFuture<Operation> generateServiceIdentity(GenerateServiceIdentityRequest request)

Generates service identity for service.

Parameter
NameDescription
requestGenerateServiceIdentityRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

getConsumerQuotaLimit(GetConsumerQuotaLimitRequest request)

public ListenableFuture<ConsumerQuotaLimit> getConsumerQuotaLimit(GetConsumerQuotaLimitRequest request)

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

Parameter
NameDescription
requestGetConsumerQuotaLimitRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ConsumerQuotaLimit>

getConsumerQuotaMetric(GetConsumerQuotaMetricRequest request)

public ListenableFuture<ConsumerQuotaMetric> getConsumerQuotaMetric(GetConsumerQuotaMetricRequest request)

Retrieves a summary of quota information for a specific quota metric

Parameter
NameDescription
requestGetConsumerQuotaMetricRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ConsumerQuotaMetric>

getService(GetServiceRequest request)

public ListenableFuture<Service> getService(GetServiceRequest request)

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

Parameter
NameDescription
requestGetServiceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Service>

importAdminOverrides(ImportAdminOverridesRequest request)

public ListenableFuture<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
NameDescription
requestImportAdminOverridesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

importConsumerOverrides(ImportConsumerOverridesRequest request)

public ListenableFuture<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
NameDescription
requestImportConsumerOverridesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

listAdminOverrides(ListAdminOverridesRequest request)

public ListenableFuture<ListAdminOverridesResponse> listAdminOverrides(ListAdminOverridesRequest request)

Lists all admin overrides on this limit.

Parameter
NameDescription
requestListAdminOverridesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListAdminOverridesResponse>

listConsumerOverrides(ListConsumerOverridesRequest request)

public ListenableFuture<ListConsumerOverridesResponse> listConsumerOverrides(ListConsumerOverridesRequest request)

Lists all consumer overrides on this limit.

Parameter
NameDescription
requestListConsumerOverridesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListConsumerOverridesResponse>

listConsumerQuotaMetrics(ListConsumerQuotaMetricsRequest request)

public ListenableFuture<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
NameDescription
requestListConsumerQuotaMetricsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListConsumerQuotaMetricsResponse>

listServices(ListServicesRequest request)

public ListenableFuture<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
NameDescription
requestListServicesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListServicesResponse>

updateAdminOverride(UpdateAdminOverrideRequest request)

public ListenableFuture<Operation> updateAdminOverride(UpdateAdminOverrideRequest request)

Updates an admin override.

Parameter
NameDescription
requestUpdateAdminOverrideRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

updateConsumerOverride(UpdateConsumerOverrideRequest request)

public ListenableFuture<Operation> updateConsumerOverride(UpdateConsumerOverrideRequest request)

Updates a consumer override.

Parameter
NameDescription
requestUpdateConsumerOverrideRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>