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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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: |
↳ 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 | |
|---|---|
| Type | Description |
string | |
setName
The DNS address at which this service is available.
An example DNS address would be:
calendar.googleapis.com.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTitle
The product title for this service.
| Returns | |
|---|---|
| Type | Description |
string | |
setTitle
The product title for this service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApis
A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Api>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDocumentation
Additional API documentation. Contains only the summary and the documentation URL.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Documentation|null | |
hasDocumentation
clearDocumentation
setDocumentation
Additional API documentation. Contains only the summary and the documentation URL.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Documentation
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuota
Quota configuration.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Quota|null | |
hasQuota
clearQuota
setQuota
Quota configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Quota
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAuthentication
Auth configuration. Contains only the OAuth rules.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Authentication|null | |
hasAuthentication
clearAuthentication
setAuthentication
Auth configuration. Contains only the OAuth rules.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Authentication
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUsage
Configuration controlling usage of this service.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Usage|null | |
hasUsage
clearUsage
setUsage
Configuration controlling usage of this service.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Usage
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndpoints
Configuration for network endpoints. Contains only the names and aliases of the endpoints.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEndpoints
Configuration for network endpoints. Contains only the names and aliases of the endpoints.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Api\Endpoint>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMonitoredResources
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array<Google\Api\MonitoredResourceDescriptor>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMonitoring
Monitoring configuration.
This should not include the 'producer_destinations' field.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Monitoring|null | |
hasMonitoring
clearMonitoring
setMonitoring
Monitoring configuration.
This should not include the 'producer_destinations' field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Monitoring
|
| Returns | |
|---|---|
| Type | Description |
$this | |