code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
---|---|---|---|---|---|---|---|
public function setServiceId($var)
{
GPBUtil::checkString($var, True);
$this->service_id = $var;
return $this;
} | Required. The ID of the metastore service, which is used as the final
component of the metastore service's name.
This value must be between 2 and 63 characters long inclusive, begin with a
letter, end with a letter or number, and consist of alpha-numeric
ASCII characters or hyphens.
Generated from protobuf field <code>string service_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setServiceId | php | googleapis/google-cloud-php | DataprocMetastore/src/V1alpha/CreateServiceRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1alpha/CreateServiceRequest.php | Apache-2.0 |
public function getService()
{
return $this->service;
} | Required. The Metastore service to create. The `name` field is
ignored. The ID of the created metastore service must be provided in
the request's `service_id` field.
Generated from protobuf field <code>.google.cloud.metastore.v1alpha.Service service = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Metastore\V1alpha\Service|null | getService | php | googleapis/google-cloud-php | DataprocMetastore/src/V1alpha/CreateServiceRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1alpha/CreateServiceRequest.php | Apache-2.0 |
public function setService($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Metastore\V1alpha\Service::class);
$this->service = $var;
return $this;
} | Required. The Metastore service to create. The `name` field is
ignored. The ID of the created metastore service must be provided in
the request's `service_id` field.
Generated from protobuf field <code>.google.cloud.metastore.v1alpha.Service service = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Metastore\V1alpha\Service $var
@return $this | setService | php | googleapis/google-cloud-php | DataprocMetastore/src/V1alpha/CreateServiceRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1alpha/CreateServiceRequest.php | Apache-2.0 |
public function getRequestId()
{
return $this->request_id;
} | Optional. A request ID. Specify a unique request ID to allow the server to
ignore the request if it has completed. The server will ignore subsequent
requests that provide a duplicate request ID for at least 60 minutes after
the first request.
For example, if an initial request times out, followed by another request
with the same request ID, the server ignores the second request to prevent
the creation of duplicate commitments.
The request ID must be a valid
[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getRequestId | php | googleapis/google-cloud-php | DataprocMetastore/src/V1alpha/CreateServiceRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1alpha/CreateServiceRequest.php | Apache-2.0 |
public function setRequestId($var)
{
GPBUtil::checkString($var, True);
$this->request_id = $var;
return $this;
} | Optional. A request ID. Specify a unique request ID to allow the server to
ignore the request if it has completed. The server will ignore subsequent
requests that provide a duplicate request ID for at least 60 minutes after
the first request.
For example, if an initial request times out, followed by another request
with the same request ID, the server ignores the second request to prevent
the creation of duplicate commitments.
The request ID must be a valid
[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setRequestId | php | googleapis/google-cloud-php | DataprocMetastore/src/V1alpha/CreateServiceRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1alpha/CreateServiceRequest.php | Apache-2.0 |
public function getBlueprints()
{
return $this->blueprints;
} | The list of requested blueprint revisions.
Generated from protobuf field <code>repeated .google.cloud.telcoautomation.v1.Blueprint blueprints = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getBlueprints | php | googleapis/google-cloud-php | TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | Apache-2.0 |
public function setBlueprints($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\TelcoAutomation\V1\Blueprint::class);
$this->blueprints = $arr;
return $this;
} | The list of requested blueprint revisions.
Generated from protobuf field <code>repeated .google.cloud.telcoautomation.v1.Blueprint blueprints = 1;</code>
@param array<\Google\Cloud\TelcoAutomation\V1\Blueprint>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setBlueprints | php | googleapis/google-cloud-php | TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | A token that can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
Generated from protobuf field <code>string next_page_token = 2;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | A token that can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
Generated from protobuf field <code>string next_page_token = 2;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/TelcoAutomation/src/V1/SearchBlueprintRevisionsResponse.php | Apache-2.0 |
public function getZoneId()
{
return isset($this->zone_id) ? $this->zone_id : '';
} | The cloud bigtable zone associated with the cluster.
Generated from protobuf field <code>optional string zone_id = 1;</code>
@return string | getZoneId | php | googleapis/google-cloud-php | Bigtable/src/V2/ResponseParams.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/ResponseParams.php | Apache-2.0 |
public function setZoneId($var)
{
GPBUtil::checkString($var, True);
$this->zone_id = $var;
return $this;
} | The cloud bigtable zone associated with the cluster.
Generated from protobuf field <code>optional string zone_id = 1;</code>
@param string $var
@return $this | setZoneId | php | googleapis/google-cloud-php | Bigtable/src/V2/ResponseParams.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/ResponseParams.php | Apache-2.0 |
public function getClusterId()
{
return isset($this->cluster_id) ? $this->cluster_id : '';
} | Identifier for a cluster that represents set of
bigtable resources.
Generated from protobuf field <code>optional string cluster_id = 2;</code>
@return string | getClusterId | php | googleapis/google-cloud-php | Bigtable/src/V2/ResponseParams.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/ResponseParams.php | Apache-2.0 |
public function setClusterId($var)
{
GPBUtil::checkString($var, True);
$this->cluster_id = $var;
return $this;
} | Identifier for a cluster that represents set of
bigtable resources.
Generated from protobuf field <code>optional string cluster_id = 2;</code>
@param string $var
@return $this | setClusterId | php | googleapis/google-cloud-php | Bigtable/src/V2/ResponseParams.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/ResponseParams.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Required. The name of the attachment to delete.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getName | php | googleapis/google-cloud-php | ArtifactRegistry/src/V1/DeleteAttachmentRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ArtifactRegistry/src/V1/DeleteAttachmentRequest.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. The name of the attachment to delete.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | ArtifactRegistry/src/V1/DeleteAttachmentRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ArtifactRegistry/src/V1/DeleteAttachmentRequest.php | Apache-2.0 |
public function getCreateTime()
{
return $this->create_time;
} | Output only. The time the operation was created.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getCreateTime | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
} | Output only. The time the operation was created.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCreateTime | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function getEndTime()
{
return $this->end_time;
} | Output only. The time the operation finished running.
Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getEndTime | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function setEndTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->end_time = $var;
return $this;
} | Output only. The time the operation finished running.
Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setEndTime | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function getTarget()
{
return $this->target;
} | Output only. Server-defined resource path for the target of the operation.
Generated from protobuf field <code>string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getTarget | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function setTarget($var)
{
GPBUtil::checkString($var, True);
$this->target = $var;
return $this;
} | Output only. Server-defined resource path for the target of the operation.
Generated from protobuf field <code>string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setTarget | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function getVerb()
{
return $this->verb;
} | Output only. Name of the verb executed by the operation.
Generated from protobuf field <code>string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getVerb | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function setVerb($var)
{
GPBUtil::checkString($var, True);
$this->verb = $var;
return $this;
} | Output only. Name of the verb executed by the operation.
Generated from protobuf field <code>string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setVerb | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function getStatusMessage()
{
return $this->status_message;
} | Output only. Human-readable status of the operation, if any.
Generated from protobuf field <code>string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getStatusMessage | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function setStatusMessage($var)
{
GPBUtil::checkString($var, True);
$this->status_message = $var;
return $this;
} | Output only. Human-readable status of the operation, if any.
Generated from protobuf field <code>string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setStatusMessage | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function getRequestedCancellation()
{
return $this->requested_cancellation;
} | Output only. Identifies whether the user has requested cancellation
of the operation. Operations that have successfully been cancelled
have [Operation.error][] value with a
[google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
`Code.CANCELLED`.
Generated from protobuf field <code>bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return bool | getRequestedCancellation | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function setRequestedCancellation($var)
{
GPBUtil::checkBool($var);
$this->requested_cancellation = $var;
return $this;
} | Output only. Identifies whether the user has requested cancellation
of the operation. Operations that have successfully been cancelled
have [Operation.error][] value with a
[google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
`Code.CANCELLED`.
Generated from protobuf field <code>bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param bool $var
@return $this | setRequestedCancellation | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function getApiVersion()
{
return $this->api_version;
} | Output only. API version used to start the operation.
Generated from protobuf field <code>string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getApiVersion | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function setApiVersion($var)
{
GPBUtil::checkString($var, True);
$this->api_version = $var;
return $this;
} | Output only. API version used to start the operation.
Generated from protobuf field <code>string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setApiVersion | php | googleapis/google-cloud-php | Dataplex/src/V1/OperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/OperationMetadata.php | Apache-2.0 |
public function getWeeklySchedule()
{
return $this->readOneof(2);
} | Weekly schedule for the Backup.
Generated from protobuf field <code>.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;</code>
@return \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\WeeklySchedule|null | getWeeklySchedule | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setWeeklySchedule($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\WeeklySchedule::class);
$this->writeOneof(2, $var);
return $this;
} | Weekly schedule for the Backup.
Generated from protobuf field <code>.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;</code>
@param \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\WeeklySchedule $var
@return $this | setWeeklySchedule | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getTimeBasedRetention()
{
return $this->readOneof(4);
} | Time-based Backup retention policy.
Generated from protobuf field <code>.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;</code>
@return \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\TimeBasedRetention|null | getTimeBasedRetention | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setTimeBasedRetention($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\TimeBasedRetention::class);
$this->writeOneof(4, $var);
return $this;
} | Time-based Backup retention policy.
Generated from protobuf field <code>.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;</code>
@param \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\TimeBasedRetention $var
@return $this | setTimeBasedRetention | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getQuantityBasedRetention()
{
return $this->readOneof(5);
} | Quantity-based Backup retention policy to retain recent backups.
Generated from protobuf field <code>.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;</code>
@return \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\QuantityBasedRetention|null | getQuantityBasedRetention | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setQuantityBasedRetention($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\QuantityBasedRetention::class);
$this->writeOneof(5, $var);
return $this;
} | Quantity-based Backup retention policy to retain recent backups.
Generated from protobuf field <code>.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;</code>
@param \Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy\QuantityBasedRetention $var
@return $this | setQuantityBasedRetention | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getEnabled()
{
return isset($this->enabled) ? $this->enabled : false;
} | Whether automated automated backups are enabled. If not set, defaults to
true.
Generated from protobuf field <code>optional bool enabled = 1;</code>
@return bool | getEnabled | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setEnabled($var)
{
GPBUtil::checkBool($var);
$this->enabled = $var;
return $this;
} | Whether automated automated backups are enabled. If not set, defaults to
true.
Generated from protobuf field <code>optional bool enabled = 1;</code>
@param bool $var
@return $this | setEnabled | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getBackupWindow()
{
return $this->backup_window;
} | The length of the time window during which a backup can be
taken. If a backup does not succeed within this time window, it will be
canceled and considered failed.
The backup window must be at least 5 minutes long. There is no upper bound
on the window. If not set, it defaults to 1 hour.
Generated from protobuf field <code>.google.protobuf.Duration backup_window = 3;</code>
@return \Google\Protobuf\Duration|null | getBackupWindow | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setBackupWindow($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->backup_window = $var;
return $this;
} | The length of the time window during which a backup can be
taken. If a backup does not succeed within this time window, it will be
canceled and considered failed.
The backup window must be at least 5 minutes long. There is no upper bound
on the window. If not set, it defaults to 1 hour.
Generated from protobuf field <code>.google.protobuf.Duration backup_window = 3;</code>
@param \Google\Protobuf\Duration $var
@return $this | setBackupWindow | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getEncryptionConfig()
{
return $this->encryption_config;
} | Optional. The encryption config can be specified to encrypt the
backups with a customer-managed encryption key (CMEK). When this field is
not specified, the backup will then use default encryption scheme to
protect the user data.
Generated from protobuf field <code>.google.cloud.alloydb.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\AlloyDb\V1\EncryptionConfig|null | getEncryptionConfig | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setEncryptionConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\EncryptionConfig::class);
$this->encryption_config = $var;
return $this;
} | Optional. The encryption config can be specified to encrypt the
backups with a customer-managed encryption key (CMEK). When this field is
not specified, the backup will then use default encryption scheme to
protect the user data.
Generated from protobuf field <code>.google.cloud.alloydb.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\AlloyDb\V1\EncryptionConfig $var
@return $this | setEncryptionConfig | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getLocation()
{
return $this->location;
} | The location where the backup will be stored. Currently, the only supported
option is to store the backup in the same region as the cluster.
If empty, defaults to the region of the cluster.
Generated from protobuf field <code>string location = 6;</code>
@return string | getLocation | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setLocation($var)
{
GPBUtil::checkString($var, True);
$this->location = $var;
return $this;
} | The location where the backup will be stored. Currently, the only supported
option is to store the backup in the same region as the cluster.
If empty, defaults to the region of the cluster.
Generated from protobuf field <code>string location = 6;</code>
@param string $var
@return $this | setLocation | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getLabels()
{
return $this->labels;
} | Labels to apply to backups created using this configuration.
Generated from protobuf field <code>map<string, string> labels = 7;</code>
@return \Google\Protobuf\Internal\MapField | getLabels | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function setLabels($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->labels = $arr;
return $this;
} | Labels to apply to backups created using this configuration.
Generated from protobuf field <code>map<string, string> labels = 7;</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setLabels | php | googleapis/google-cloud-php | AlloyDb/src/V1/AutomatedBackupPolicy.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/AutomatedBackupPolicy.php | Apache-2.0 |
public function getModel()
{
return $this->model;
} | Model metadata.
Generated from protobuf field <code>.google.cloud.audit.BigQueryAuditMetadata.Model model = 1;</code>
@return \Google\Cloud\Audit\BigQueryAuditMetadata\Model|null | getModel | php | googleapis/google-cloud-php | CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | https://github.com/googleapis/google-cloud-php/blob/master/CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | Apache-2.0 |
public function setModel($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Audit\BigQueryAuditMetadata\Model::class);
$this->model = $var;
return $this;
} | Model metadata.
Generated from protobuf field <code>.google.cloud.audit.BigQueryAuditMetadata.Model model = 1;</code>
@param \Google\Cloud\Audit\BigQueryAuditMetadata\Model $var
@return $this | setModel | php | googleapis/google-cloud-php | CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | https://github.com/googleapis/google-cloud-php/blob/master/CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | Apache-2.0 |
public function getReason()
{
return $this->reason;
} | Describes how the model was created.
Generated from protobuf field <code>.google.cloud.audit.BigQueryAuditMetadata.ModelCreation.Reason reason = 3;</code>
@return int | getReason | php | googleapis/google-cloud-php | CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | https://github.com/googleapis/google-cloud-php/blob/master/CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | Apache-2.0 |
public function setReason($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Audit\BigQueryAuditMetadata\ModelCreation\Reason::class);
$this->reason = $var;
return $this;
} | Describes how the model was created.
Generated from protobuf field <code>.google.cloud.audit.BigQueryAuditMetadata.ModelCreation.Reason reason = 3;</code>
@param int $var
@return $this | setReason | php | googleapis/google-cloud-php | CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | https://github.com/googleapis/google-cloud-php/blob/master/CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | Apache-2.0 |
public function getJobName()
{
return $this->job_name;
} | The URI of the job that created the model.
Format: `projects/<project_id>/jobs/<job_id>`.
Generated from protobuf field <code>string job_name = 4;</code>
@return string | getJobName | php | googleapis/google-cloud-php | CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | https://github.com/googleapis/google-cloud-php/blob/master/CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | Apache-2.0 |
public function setJobName($var)
{
GPBUtil::checkString($var, True);
$this->job_name = $var;
return $this;
} | The URI of the job that created the model.
Format: `projects/<project_id>/jobs/<job_id>`.
Generated from protobuf field <code>string job_name = 4;</code>
@param string $var
@return $this | setJobName | php | googleapis/google-cloud-php | CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | https://github.com/googleapis/google-cloud-php/blob/master/CloudCommonProtos/src/Audit/BigQueryAuditMetadata/ModelCreation.php | Apache-2.0 |
public function getFindingId()
{
return $this->readOneof(1);
} | For infotype transformations, link to the corresponding findings ID so
that location information does not need to be duplicated. Each findings
ID correlates to an entry in the findings output table, this table only
gets created when users specify to save findings (add the save findings
action to the request).
Generated from protobuf field <code>string finding_id = 1;</code>
@return string | getFindingId | php | googleapis/google-cloud-php | Dlp/src/V2/TransformationLocation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/TransformationLocation.php | Apache-2.0 |
public function setFindingId($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(1, $var);
return $this;
} | For infotype transformations, link to the corresponding findings ID so
that location information does not need to be duplicated. Each findings
ID correlates to an entry in the findings output table, this table only
gets created when users specify to save findings (add the save findings
action to the request).
Generated from protobuf field <code>string finding_id = 1;</code>
@param string $var
@return $this | setFindingId | php | googleapis/google-cloud-php | Dlp/src/V2/TransformationLocation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/TransformationLocation.php | Apache-2.0 |
public function getRecordTransformation()
{
return $this->readOneof(2);
} | For record transformations, provide a field and container information.
Generated from protobuf field <code>.google.privacy.dlp.v2.RecordTransformation record_transformation = 2;</code>
@return \Google\Cloud\Dlp\V2\RecordTransformation|null | getRecordTransformation | php | googleapis/google-cloud-php | Dlp/src/V2/TransformationLocation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/TransformationLocation.php | Apache-2.0 |
public function setRecordTransformation($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dlp\V2\RecordTransformation::class);
$this->writeOneof(2, $var);
return $this;
} | For record transformations, provide a field and container information.
Generated from protobuf field <code>.google.privacy.dlp.v2.RecordTransformation record_transformation = 2;</code>
@param \Google\Cloud\Dlp\V2\RecordTransformation $var
@return $this | setRecordTransformation | php | googleapis/google-cloud-php | Dlp/src/V2/TransformationLocation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/TransformationLocation.php | Apache-2.0 |
public function getContainerType()
{
return $this->container_type;
} | Information about the functionality of the container where this finding
occurred, if available.
Generated from protobuf field <code>.google.privacy.dlp.v2.TransformationContainerType container_type = 3;</code>
@return int | getContainerType | php | googleapis/google-cloud-php | Dlp/src/V2/TransformationLocation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/TransformationLocation.php | Apache-2.0 |
public function setContainerType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Dlp\V2\TransformationContainerType::class);
$this->container_type = $var;
return $this;
} | Information about the functionality of the container where this finding
occurred, if available.
Generated from protobuf field <code>.google.privacy.dlp.v2.TransformationContainerType container_type = 3;</code>
@param int $var
@return $this | setContainerType | php | googleapis/google-cloud-php | Dlp/src/V2/TransformationLocation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/TransformationLocation.php | Apache-2.0 |
public function getId()
{
return isset($this->id) ? $this->id : '';
} | [Output Only] Unique identifier for the resource; defined by the server.
Generated from protobuf field <code>optional string id = 3355;</code>
@return string | getId | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function setId($var)
{
GPBUtil::checkString($var, True);
$this->id = $var;
return $this;
} | [Output Only] Unique identifier for the resource; defined by the server.
Generated from protobuf field <code>optional string id = 3355;</code>
@param string $var
@return $this | setId | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function getItems()
{
return $this->items;
} | A list of Subnetwork resources.
Generated from protobuf field <code>repeated .google.cloud.compute.v1.Subnetwork items = 100526016;</code>
@return \Google\Protobuf\Internal\RepeatedField | getItems | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function setItems($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Compute\V1\Subnetwork::class);
$this->items = $arr;
return $this;
} | A list of Subnetwork resources.
Generated from protobuf field <code>repeated .google.cloud.compute.v1.Subnetwork items = 100526016;</code>
@param array<\Google\Cloud\Compute\V1\Subnetwork>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setItems | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function getKind()
{
return isset($this->kind) ? $this->kind : '';
} | [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
Generated from protobuf field <code>optional string kind = 3292052;</code>
@return string | getKind | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function setKind($var)
{
GPBUtil::checkString($var, True);
$this->kind = $var;
return $this;
} | [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
Generated from protobuf field <code>optional string kind = 3292052;</code>
@param string $var
@return $this | setKind | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function getNextPageToken()
{
return isset($this->next_page_token) ? $this->next_page_token : '';
} | [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Generated from protobuf field <code>optional string next_page_token = 79797525;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Generated from protobuf field <code>optional string next_page_token = 79797525;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function getSelfLink()
{
return isset($this->self_link) ? $this->self_link : '';
} | [Output Only] Server-defined URL for this resource.
Generated from protobuf field <code>optional string self_link = 456214797;</code>
@return string | getSelfLink | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function setSelfLink($var)
{
GPBUtil::checkString($var, True);
$this->self_link = $var;
return $this;
} | [Output Only] Server-defined URL for this resource.
Generated from protobuf field <code>optional string self_link = 456214797;</code>
@param string $var
@return $this | setSelfLink | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function getWarning()
{
return $this->warning;
} | [Output Only] Informational warning message.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Warning warning = 50704284;</code>
@return \Google\Cloud\Compute\V1\Warning|null | getWarning | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function setWarning($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\Warning::class);
$this->warning = $var;
return $this;
} | [Output Only] Informational warning message.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Warning warning = 50704284;</code>
@param \Google\Cloud\Compute\V1\Warning $var
@return $this | setWarning | php | googleapis/google-cloud-php | Compute/src/V1/SubnetworkList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SubnetworkList.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Required. A unique identifier for the instance, which cannot be changed
after the instance is created. Values are of the form
`projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
segment of the name must be between 2 and 64 characters in length.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getName | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. A unique identifier for the instance, which cannot be changed
after the instance is created. Values are of the form
`projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
segment of the name must be between 2 and 64 characters in length.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getConfig()
{
return $this->config;
} | Required. The name of the instance's configuration. Values are of the form
`projects/<project>/instanceConfigs/<configuration>`. See
also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
[ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Generated from protobuf field <code>string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getConfig | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setConfig($var)
{
GPBUtil::checkString($var, True);
$this->config = $var;
return $this;
} | Required. The name of the instance's configuration. Values are of the form
`projects/<project>/instanceConfigs/<configuration>`. See
also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
[ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Generated from protobuf field <code>string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setConfig | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getDisplayName()
{
return $this->display_name;
} | Required. The descriptive name for this instance as it appears in UIs.
Must be unique per project and between 4 and 30 characters in length.
Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getDisplayName | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setDisplayName($var)
{
GPBUtil::checkString($var, True);
$this->display_name = $var;
return $this;
} | Required. The descriptive name for this instance as it appears in UIs.
Must be unique per project and between 4 and 30 characters in length.
Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setDisplayName | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getNodeCount()
{
return $this->node_count;
} | The number of nodes allocated to this instance. At most, one of either
`node_count` or `processing_units` should be present in the message.
Users can set the `node_count` field to specify the target number of nodes
allocated to the instance.
If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY`
field and reflects the current number of nodes allocated to the instance.
This might be zero in API responses for instances that are not yet in the
`READY` state.
For more information, see
[Compute capacity, nodes, and processing
units](https://cloud.google.com/spanner/docs/compute-capacity).
Generated from protobuf field <code>int32 node_count = 5;</code>
@return int | getNodeCount | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setNodeCount($var)
{
GPBUtil::checkInt32($var);
$this->node_count = $var;
return $this;
} | The number of nodes allocated to this instance. At most, one of either
`node_count` or `processing_units` should be present in the message.
Users can set the `node_count` field to specify the target number of nodes
allocated to the instance.
If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY`
field and reflects the current number of nodes allocated to the instance.
This might be zero in API responses for instances that are not yet in the
`READY` state.
For more information, see
[Compute capacity, nodes, and processing
units](https://cloud.google.com/spanner/docs/compute-capacity).
Generated from protobuf field <code>int32 node_count = 5;</code>
@param int $var
@return $this | setNodeCount | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getProcessingUnits()
{
return $this->processing_units;
} | The number of processing units allocated to this instance. At most, one of
either `processing_units` or `node_count` should be present in the message.
Users can set the `processing_units` field to specify the target number of
processing units allocated to the instance.
If autoscaling is enabled, `processing_units` is treated as an
`OUTPUT_ONLY` field and reflects the current number of processing units
allocated to the instance.
This might be zero in API responses for instances that are not yet in the
`READY` state.
For more information, see
[Compute capacity, nodes and processing
units](https://cloud.google.com/spanner/docs/compute-capacity).
Generated from protobuf field <code>int32 processing_units = 9;</code>
@return int | getProcessingUnits | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setProcessingUnits($var)
{
GPBUtil::checkInt32($var);
$this->processing_units = $var;
return $this;
} | The number of processing units allocated to this instance. At most, one of
either `processing_units` or `node_count` should be present in the message.
Users can set the `processing_units` field to specify the target number of
processing units allocated to the instance.
If autoscaling is enabled, `processing_units` is treated as an
`OUTPUT_ONLY` field and reflects the current number of processing units
allocated to the instance.
This might be zero in API responses for instances that are not yet in the
`READY` state.
For more information, see
[Compute capacity, nodes and processing
units](https://cloud.google.com/spanner/docs/compute-capacity).
Generated from protobuf field <code>int32 processing_units = 9;</code>
@param int $var
@return $this | setProcessingUnits | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getReplicaComputeCapacity()
{
return $this->replica_compute_capacity;
} | Output only. Lists the compute capacity per ReplicaSelection. A replica
selection identifies a set of replicas with common properties. Replicas
identified by a ReplicaSelection are scaled with the same compute capacity.
Generated from protobuf field <code>repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Internal\RepeatedField | getReplicaComputeCapacity | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setReplicaComputeCapacity($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaComputeCapacity::class);
$this->replica_compute_capacity = $arr;
return $this;
} | Output only. Lists the compute capacity per ReplicaSelection. A replica
selection identifies a set of replicas with common properties. Replicas
identified by a ReplicaSelection are scaled with the same compute capacity.
Generated from protobuf field <code>repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param array<\Google\Cloud\Spanner\Admin\Instance\V1\ReplicaComputeCapacity>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setReplicaComputeCapacity | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getAutoscalingConfig()
{
return $this->autoscaling_config;
} | Optional. The autoscaling configuration. Autoscaling is enabled if this
field is set. When autoscaling is enabled, node_count and processing_units
are treated as OUTPUT_ONLY fields and reflect the current compute capacity
allocated to the instance.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.AutoscalingConfig autoscaling_config = 17 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig|null | getAutoscalingConfig | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setAutoscalingConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig::class);
$this->autoscaling_config = $var;
return $this;
} | Optional. The autoscaling configuration. Autoscaling is enabled if this
field is set. When autoscaling is enabled, node_count and processing_units
are treated as OUTPUT_ONLY fields and reflect the current compute capacity
allocated to the instance.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.AutoscalingConfig autoscaling_config = 17 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig $var
@return $this | setAutoscalingConfig | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getState()
{
return $this->state;
} | Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance],
the state must be either omitted or set to `CREATING`. For
[UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance],
the state must be either omitted or set to `READY`.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int | getState | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\Instance\State::class);
$this->state = $var;
return $this;
} | Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance],
the state must be either omitted or set to `CREATING`. For
[UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance],
the state must be either omitted or set to `READY`.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setState | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getLabels()
{
return $this->labels;
} | Cloud Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. Cloud Labels can be used to filter collections of
resources. They can be used to control how resource metrics are aggregated.
And they can be used as arguments to policy management rules (e.g. route,
firewall, load balancing, etc.).
* Label keys must be between 1 and 63 characters long and must conform to
the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression `[a-z0-9_-]{0,63}`.
* No more than 64 labels can be associated with a given resource.
See https://goo.gl/xmQnxf for more information on and examples of labels.
If you plan to use labels in your own code, please note that additional
characters may be allowed in the future. And so you are advised to use an
internal label representation, such as JSON, which doesn't rely upon
specific characters being disallowed. For example, representing labels
as the string: name + "_" + value would prove problematic if we were to
allow "_" in a future release.
Generated from protobuf field <code>map<string, string> labels = 7;</code>
@return \Google\Protobuf\Internal\MapField | getLabels | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setLabels($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->labels = $arr;
return $this;
} | Cloud Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. Cloud Labels can be used to filter collections of
resources. They can be used to control how resource metrics are aggregated.
And they can be used as arguments to policy management rules (e.g. route,
firewall, load balancing, etc.).
* Label keys must be between 1 and 63 characters long and must conform to
the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression `[a-z0-9_-]{0,63}`.
* No more than 64 labels can be associated with a given resource.
See https://goo.gl/xmQnxf for more information on and examples of labels.
If you plan to use labels in your own code, please note that additional
characters may be allowed in the future. And so you are advised to use an
internal label representation, such as JSON, which doesn't rely upon
specific characters being disallowed. For example, representing labels
as the string: name + "_" + value would prove problematic if we were to
allow "_" in a future release.
Generated from protobuf field <code>map<string, string> labels = 7;</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setLabels | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getInstanceType()
{
return $this->instance_type;
} | The `InstanceType` of the current instance.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;</code>
@return int | getInstanceType | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setInstanceType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\Instance\InstanceType::class);
$this->instance_type = $var;
return $this;
} | The `InstanceType` of the current instance.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;</code>
@param int $var
@return $this | setInstanceType | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getEndpointUris()
{
return $this->endpoint_uris;
} | Deprecated. This field is not populated.
Generated from protobuf field <code>repeated string endpoint_uris = 8;</code>
@return \Google\Protobuf\Internal\RepeatedField | getEndpointUris | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setEndpointUris($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->endpoint_uris = $arr;
return $this;
} | Deprecated. This field is not populated.
Generated from protobuf field <code>repeated string endpoint_uris = 8;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setEndpointUris | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getCreateTime()
{
return $this->create_time;
} | Output only. The time at which the instance was created.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getCreateTime | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
} | Output only. The time at which the instance was created.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCreateTime | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getUpdateTime()
{
return $this->update_time;
} | Output only. The time at which the instance was most recently updated.
Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getUpdateTime | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setUpdateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->update_time = $var;
return $this;
} | Output only. The time at which the instance was most recently updated.
Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setUpdateTime | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getFreeInstanceMetadata()
{
return $this->free_instance_metadata;
} | Free instance metadata. Only populated for free instances.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;</code>
@return \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata|null | getFreeInstanceMetadata | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setFreeInstanceMetadata($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata::class);
$this->free_instance_metadata = $var;
return $this;
} | Free instance metadata. Only populated for free instances.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;</code>
@param \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata $var
@return $this | setFreeInstanceMetadata | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getEdition()
{
return $this->edition;
} | Optional. The `Edition` of the current instance.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getEdition | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function setEdition($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\Instance\Edition::class);
$this->edition = $var;
return $this;
} | Optional. The `Edition` of the current instance.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setEdition | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
public function getDefaultBackupScheduleType()
{
return $this->default_backup_schedule_type;
} | Optional. Controls the default backup schedule behavior for new databases
within the instance. By default, a backup schedule is created automatically
when a new database is created in a new instance.
Note that the `AUTOMATIC` value isn't permitted for free instances,
as backups and backup schedules aren't supported for free instances.
In the `GetInstance` or `ListInstances` response, if the value of
`default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't
create a default backup schedule for new databases in the instance.
Generated from protobuf field <code>.google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getDefaultBackupScheduleType | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/Instance.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/Instance.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.