Class ServiceUsageGrpc.ServiceUsageStub (2.13.0)

public static final class ServiceUsageGrpc.ServiceUsageStub extends AbstractAsyncStub<ServiceUsageGrpc.ServiceUsageStub>

Service Usage API

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > ServiceUsageGrpc.ServiceUsageStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

batchEnableServices(BatchEnableServicesRequest request, StreamObserver<Operation> responseObserver)

public void batchEnableServices(BatchEnableServicesRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`BatchEnableServicesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

build(Channel channel, CallOptions callOptions)

protected ServiceUsageGrpc.ServiceUsageStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`ServiceUsageGrpc.ServiceUsageStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAdminOverride(CreateAdminOverrideRequest request, StreamObserver<Operation> responseObserver)

public void createAdminOverride(CreateAdminOverrideRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`CreateAdminOverrideRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

createConsumerOverride(CreateConsumerOverrideRequest request, StreamObserver<Operation> responseObserver)

public void createConsumerOverride(CreateConsumerOverrideRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`CreateConsumerOverrideRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteAdminOverride(DeleteAdminOverrideRequest request, StreamObserver<Operation> responseObserver)

public void deleteAdminOverride(DeleteAdminOverrideRequest request, StreamObserver<Operation> responseObserver)

Deletes an admin override.

Parameters
Name	Description
`request`	`DeleteAdminOverrideRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteConsumerOverride(DeleteConsumerOverrideRequest request, StreamObserver<Operation> responseObserver)

public void deleteConsumerOverride(DeleteConsumerOverrideRequest request, StreamObserver<Operation> responseObserver)

Deletes a consumer override.

Parameters
Name	Description
`request`	`DeleteConsumerOverrideRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

disableService(DisableServiceRequest request, StreamObserver<Operation> responseObserver)

public void disableService(DisableServiceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`DisableServiceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

enableService(EnableServiceRequest request, StreamObserver<Operation> responseObserver)

public void enableService(EnableServiceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`EnableServiceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

generateServiceIdentity(GenerateServiceIdentityRequest request, StreamObserver<Operation> responseObserver)

public void generateServiceIdentity(GenerateServiceIdentityRequest request, StreamObserver<Operation> responseObserver)

Generates service identity for service.

Parameters
Name	Description
`request`	`GenerateServiceIdentityRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

getConsumerQuotaLimit(GetConsumerQuotaLimitRequest request, StreamObserver<ConsumerQuotaLimit> responseObserver)

public void getConsumerQuotaLimit(GetConsumerQuotaLimitRequest request, StreamObserver<ConsumerQuotaLimit> responseObserver)

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

Parameters
Name	Description
`request`	`GetConsumerQuotaLimitRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ConsumerQuotaLimit>`

getConsumerQuotaMetric(GetConsumerQuotaMetricRequest request, StreamObserver<ConsumerQuotaMetric> responseObserver)

public void getConsumerQuotaMetric(GetConsumerQuotaMetricRequest request, StreamObserver<ConsumerQuotaMetric> responseObserver)

Retrieves a summary of quota information for a specific quota metric

Parameters
Name	Description
`request`	`GetConsumerQuotaMetricRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ConsumerQuotaMetric>`

getService(GetServiceRequest request, StreamObserver<Service> responseObserver)

public void getService(GetServiceRequest request, StreamObserver<Service> responseObserver)

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

Parameters
Name	Description
`request`	`GetServiceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Service>`

importAdminOverrides(ImportAdminOverridesRequest request, StreamObserver<Operation> responseObserver)

public void importAdminOverrides(ImportAdminOverridesRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`ImportAdminOverridesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

importConsumerOverrides(ImportConsumerOverridesRequest request, StreamObserver<Operation> responseObserver)

public void importConsumerOverrides(ImportConsumerOverridesRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`ImportConsumerOverridesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

listAdminOverrides(ListAdminOverridesRequest request, StreamObserver<ListAdminOverridesResponse> responseObserver)

public void listAdminOverrides(ListAdminOverridesRequest request, StreamObserver<ListAdminOverridesResponse> responseObserver)

Lists all admin overrides on this limit.

Parameters
Name	Description
`request`	`ListAdminOverridesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListAdminOverridesResponse>`

listConsumerOverrides(ListConsumerOverridesRequest request, StreamObserver<ListConsumerOverridesResponse> responseObserver)

public void listConsumerOverrides(ListConsumerOverridesRequest request, StreamObserver<ListConsumerOverridesResponse> responseObserver)

Lists all consumer overrides on this limit.

Parameters
Name	Description
`request`	`ListConsumerOverridesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListConsumerOverridesResponse>`

listConsumerQuotaMetrics(ListConsumerQuotaMetricsRequest request, StreamObserver<ListConsumerQuotaMetricsResponse> responseObserver)

public void listConsumerQuotaMetrics(ListConsumerQuotaMetricsRequest request, StreamObserver<ListConsumerQuotaMetricsResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`ListConsumerQuotaMetricsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListConsumerQuotaMetricsResponse>`

listServices(ListServicesRequest request, StreamObserver<ListServicesResponse> responseObserver)

public void listServices(ListServicesRequest request, StreamObserver<ListServicesResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`ListServicesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListServicesResponse>`

updateAdminOverride(UpdateAdminOverrideRequest request, StreamObserver<Operation> responseObserver)

public void updateAdminOverride(UpdateAdminOverrideRequest request, StreamObserver<Operation> responseObserver)

Updates an admin override.

Parameters
Name	Description
`request`	`UpdateAdminOverrideRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateConsumerOverride(UpdateConsumerOverrideRequest request, StreamObserver<Operation> responseObserver)

public void updateConsumerOverride(UpdateConsumerOverrideRequest request, StreamObserver<Operation> responseObserver)

Updates a consumer override.

Parameters
Name	Description
`request`	`UpdateConsumerOverrideRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`