ServiceUsage

import { ServiceUsage } from "https://googleapis.deno.dev/v1/serviceusage:v1.ts";

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.

class ServiceUsage {

constructor(client?: CredentialsClient, baseUrl?: string);

async operationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async operationsDelete(name: string): Promise<Empty>;

async operationsGet(name: string): Promise<Operation>;

async operationsList(opts?: OperationsListOptions): Promise<ListOperationsResponse>;

async servicesBatchEnable(parent: string, req: BatchEnableServicesRequest): Promise<Operation>;

async servicesBatchGet(parent: string, opts?: ServicesBatchGetOptions): Promise<BatchGetServicesResponse>;

async servicesDisable(name: string, req: DisableServiceRequest): Promise<Operation>;

async servicesEnable(name: string, req: EnableServiceRequest): Promise<Operation>;

async servicesGet(name: string): Promise<GoogleApiServiceusageV1Service>;

async servicesList(parent: string, opts?: ServicesListOptions): Promise<ListServicesResponse>;

}

§Constructors

new ServiceUsage(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

operationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

operationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

operationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

operationsList(opts?: OperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

servicesBatchEnable(parent: string, req: BatchEnableServicesRequest): Promise<Operation>

[src]

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.

@param parent

Parent to enable services on. An example name would be: projects/123 where 123 is the project number. The BatchEnableServices method currently only supports projects.

servicesBatchGet(parent: string, opts?: ServicesBatchGetOptions): Promise<BatchGetServicesResponse>

[src]

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

@param parent

Parent to retrieve services from. If this is set, the parent of all of the services specified in names must match this field. An example name would be: projects/123 where 123 is the project number. The BatchGetServices method currently only supports projects.

servicesDisable(name: string, req: DisableServiceRequest): Promise<Operation>

[src]

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.

@param name

Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: projects/123/services/serviceusage.googleapis.com where 123 is the project number.

servicesEnable(name: string, req: EnableServiceRequest): Promise<Operation>

[src]

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

@param name

Name of the consumer and service to enable the service on. The EnableService and DisableService methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: projects/123/services/serviceusage.googleapis.com where 123 is the project number.

servicesGet(name: string): Promise<GoogleApiServiceusageV1Service>

[src]

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

@param name

Name of the consumer and service to get the ConsumerState for. An example name would be: projects/123/services/serviceusage.googleapis.com where 123 is the project number.

servicesList(parent: string, opts?: ServicesListOptions): Promise<ListServicesResponse>

[src]

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.

@param parent

Parent to search for services on. An example name would be: projects/123 where 123 is the project number.