class Services extends Resource (View source)

The "services" collection of methods.

Typical usage is:

 $serviceusageService = new Google\Service\ServiceUsage(...);
 $services = $serviceusageService->services;

Methods

batchEnable(string $parent, BatchEnableServicesRequest $postBody, array $optParams = [])

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.

batchGet(string $parent, array $optParams = [])

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

disable(string $name, DisableServiceRequest $postBody, array $optParams = [])

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. (services.disable)

enable(string $name, EnableServiceRequest $postBody, array $optParams = [])

Enable a service so that it can be used with a project. (services.enable)

get(string $name, array $optParams = [])

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

listServices(string $parent, array $optParams = [])

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. (services.listServices)

Details

Operation batchEnable(string $parent, BatchEnableServicesRequest $postBody, array $optParams = [])

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. (services.batchEnable)

Parameters

string $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.

BatchEnableServicesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

BatchGetServicesResponse batchGet(string $parent, array $optParams = [])

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

Parameters

string $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.

array $optParams

Optional parameters.

Return Value

BatchGetServicesResponse

Exceptions

Exception

Operation disable(string $name, DisableServiceRequest $postBody, array $optParams = [])

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. (services.disable)

Parameters

string $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.

DisableServiceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation enable(string $name, EnableServiceRequest $postBody, array $optParams = [])

Enable a service so that it can be used with a project. (services.enable)

Parameters

string $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.

EnableServiceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

GoogleApiServiceusageV1Service get(string $name, array $optParams = [])

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

(services.get)

Parameters

string $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.

array $optParams

Optional parameters.

Return Value

GoogleApiServiceusageV1Service

Exceptions

Exception

ListServicesResponse listServices(string $parent, array $optParams = [])

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. (services.listServices)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

ListServicesResponse

Exceptions

Exception