Google Cloud Service Usage V1 Client - Class ServiceConfig (1.2.3)

Reference documentation and code samples for the Google Cloud Service Usage V1 Client class ServiceConfig.

The configuration of the service.

Generated from protobuf message google.api.serviceusage.v1.ServiceConfig

Namespace

Google \ Cloud \ ServiceUsage \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ 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 array<Google\Protobuf\Api>

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

↳ documentation Google\Api\Documentation

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

↳ quota Google\Api\Quota

Quota configuration.

↳ authentication Google\Api\Authentication

Auth configuration. Contains only the OAuth rules.

↳ usage Google\Api\Usage

Configuration controlling usage of this service.

↳ endpoints array<Google\Api\Endpoint>

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

↳ monitored_resources array<Google\Api\MonitoredResourceDescriptor>

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

↳ monitoring Google\Api\Monitoring

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

getName

The DNS address at which this service is available.

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

Returns
TypeDescription
string

setName

The DNS address at which this service is available.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTitle

The product title for this service.

Returns
TypeDescription
string

setTitle

The product title for this service.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getApis

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setApis

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

Parameter
NameDescription
var array<Google\Protobuf\Api>
Returns
TypeDescription
$this

getDocumentation

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

Returns
TypeDescription
Google\Api\Documentation|null

hasDocumentation

clearDocumentation

setDocumentation

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

Parameter
NameDescription
var Google\Api\Documentation
Returns
TypeDescription
$this

getQuota

Quota configuration.

Returns
TypeDescription
Google\Api\Quota|null

hasQuota

clearQuota

setQuota

Quota configuration.

Parameter
NameDescription
var Google\Api\Quota
Returns
TypeDescription
$this

getAuthentication

Auth configuration. Contains only the OAuth rules.

Returns
TypeDescription
Google\Api\Authentication|null

hasAuthentication

clearAuthentication

setAuthentication

Auth configuration. Contains only the OAuth rules.

Parameter
NameDescription
var Google\Api\Authentication
Returns
TypeDescription
$this

getUsage

Configuration controlling usage of this service.

Returns
TypeDescription
Google\Api\Usage|null

hasUsage

clearUsage

setUsage

Configuration controlling usage of this service.

Parameter
NameDescription
var Google\Api\Usage
Returns
TypeDescription
$this

getEndpoints

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEndpoints

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

Parameter
NameDescription
var array<Google\Api\Endpoint>
Returns
TypeDescription
$this

getMonitoredResources

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMonitoredResources

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

Parameter
NameDescription
var array<Google\Api\MonitoredResourceDescriptor>
Returns
TypeDescription
$this

getMonitoring

Monitoring configuration.

This should not include the 'producer_destinations' field.

Returns
TypeDescription
Google\Api\Monitoring|null

hasMonitoring

clearMonitoring

setMonitoring

Monitoring configuration.

This should not include the 'producer_destinations' field.

Parameter
NameDescription
var Google\Api\Monitoring
Returns
TypeDescription
$this