REST Resource: services

Resource: Service

A service that is available for use by the consumer.

JSON representation
{
  "name": string,
  "parent": string,
  "config": {
    object (ServiceConfig)
  },
  "state": enum (State)
}
Fields
name

string

The resource name of the consumer and service.

A valid name would be: - projects/123/services/serviceusage.googleapis.com

parent

string

The resource name of the consumer.

A valid name would be: - projects/123

config

object (ServiceConfig)

The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the services.list method. These fields are present only in responses to the services.get method.

state

enum (State)

Whether or not the service has been enabled for use by the consumer.

ServiceConfig

The configuration of the service.

JSON representation
{
  "name": string,
  "title": string,
  "apis": [
    {
      object (Api)
    }
  ],
  "documentation": {
    object (Documentation)
  },
  "quota": {
    object (Quota)
  },
  "authentication": {
    object (Authentication)
  },
  "usage": {
    object (Usage)
  },
  "endpoints": [
    {
      object (Endpoint)
    }
  ],
  "monitoredResources": [
    {
      object (MonitoredResourceDescriptor)
    }
  ],
  "monitoring": {
    object (Monitoring)
  }
}
Fields
name

string

The DNS address at which this service is available.

An example DNS address would be: calendar.googleapis.com.

title

string

The product title for this service.

apis[]

object (Api)

A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.

documentation

object (Documentation)

Additional API documentation. Contains only the summary and the documentation URL.

quota

object (Quota)

Quota configuration.

authentication

object (Authentication)

Auth configuration. Contains only the OAuth rules.

usage

object (Usage)

Configuration controlling usage of this service.

endpoints[]

object (Endpoint)

Configuration for network endpoints. Contains only the names and aliases of the endpoints.

monitoredResources[]

object (MonitoredResourceDescriptor)

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

monitoring

object (Monitoring)

Monitoring configuration. This should not include the 'producerDestinations' field.

State

Whether or not a service has been enabled for use by a consumer.

Enums
STATE_UNSPECIFIED The default value, which indicates that the enabled state of the service is unspecified or not meaningful. Currently, all consumers other than projects (such as folders and organizations) are always in this state.
DISABLED The service cannot be used by this consumer. It has either been explicitly disabled, or has never been enabled.
ENABLED The service has been explicitly enabled for use by this consumer.

Methods

batchEnable

Enable multiple services on a project.

batchGet

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

disable

Disable a service so that it can no longer be used with a project.

enable

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

get

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

list

List all services available to the specified project, and the current state of those services with respect to the project.