Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class Backup.
The details of a backup resource.
Generated from protobuf message google.cloud.metastore.v1.Backup
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. The relative resource name of the backup, in the following form: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the backup was started. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The time when the backup finished creating. |
↳ state |
int
Output only. The current state of the backup. |
↳ service_revision |
Google\Cloud\Metastore\V1\Service
Output only. The revision of the service at the time of backup. |
↳ description |
string
The description of the backup. |
↳ restoring_services |
array
Output only. Services that are restoring from the backup. |
getName
Immutable. The relative resource name of the backup, in the following form:
projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
string |
setName
Immutable. The relative resource name of the backup, in the following form:
projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
Output only. The time when the backup was started.
Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the backup was started.
Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getEndTime
Output only. The time when the backup finished creating.
Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasEndTime
clearEndTime
setEndTime
Output only. The time when the backup finished creating.
Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getState
Output only. The current state of the backup.
Generated from protobuf field .google.cloud.metastore.v1.Backup.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
setState
Output only. The current state of the backup.
Generated from protobuf field .google.cloud.metastore.v1.Backup.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getServiceRevision
Output only. The revision of the service at the time of backup.
Generated from protobuf field .google.cloud.metastore.v1.Service service_revision = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Cloud\Metastore\V1\Service|null |
hasServiceRevision
clearServiceRevision
setServiceRevision
Output only. The revision of the service at the time of backup.
Generated from protobuf field .google.cloud.metastore.v1.Service service_revision = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Metastore\V1\Service
|
Returns | |
---|---|
Type | Description |
$this |
getDescription
The description of the backup.
Generated from protobuf field string description = 6;
Returns | |
---|---|
Type | Description |
string |
setDescription
The description of the backup.
Generated from protobuf field string description = 6;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getRestoringServices
Output only. Services that are restoring from the backup.
Generated from protobuf field repeated string restoring_services = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setRestoringServices
Output only. Services that are restoring from the backup.
Generated from protobuf field repeated string restoring_services = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |