Reference documentation and code samples for the Compute V1 Client class ResourcePolicy.
Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.
Generated from protobuf message google.cloud.compute.v1.ResourcePolicy
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ creation_timestamp |
string
[Output Only] Creation timestamp in RFC3339 text format. |
↳ description |
string
|
↳ group_placement_policy |
Google\Cloud\Compute\V1\ResourcePolicyGroupPlacementPolicy
Resource policy for instances for placement configuration. |
↳ id |
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
↳ instance_schedule_policy |
Google\Cloud\Compute\V1\ResourcePolicyInstanceSchedulePolicy
Resource policy for scheduling instance operations. |
↳ kind |
string
[Output Only] Type of the resource. Always compute#resource_policies for resource policies. |
↳ name |
string
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
↳ region |
string
|
↳ resource_status |
Google\Cloud\Compute\V1\ResourcePolicyResourceStatus
[Output Only] The system status of the resource policy. |
↳ self_link |
string
[Output Only] Server-defined fully-qualified URL for this resource. |
↳ snapshot_schedule_policy |
Google\Cloud\Compute\V1\ResourcePolicySnapshotSchedulePolicy
Resource policy for persistent disks for creating snapshots. |
↳ status |
string
[Output Only] The status of resource policy creation. Check the Status enum for the list of possible values. |
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Generated from protobuf field optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
Generated from protobuf field optional string description = 422937596;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGroupPlacementPolicy
Resource policy for instances for placement configuration.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\ResourcePolicyGroupPlacementPolicy|null | |
hasGroupPlacementPolicy
clearGroupPlacementPolicy
setGroupPlacementPolicy
Resource policy for instances for placement configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\ResourcePolicyGroupPlacementPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceSchedulePolicy
Resource policy for scheduling instance operations.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\ResourcePolicyInstanceSchedulePolicy|null | |
hasInstanceSchedulePolicy
clearInstanceSchedulePolicy
setInstanceSchedulePolicy
Resource policy for scheduling instance operations.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\ResourcePolicyInstanceSchedulePolicy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] Type of the resource. Always compute#resource_policies for resource policies.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#resource_policies for resource policies.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
Generated from protobuf field optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
string | |
hasRegion
clearRegion
setRegion
Generated from protobuf field optional string region = 138946292;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceStatus
[Output Only] The system status of the resource policy.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\ResourcePolicyResourceStatus|null | |
hasResourceStatus
clearResourceStatus
setResourceStatus
[Output Only] The system status of the resource policy.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\ResourcePolicyResourceStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSnapshotSchedulePolicy
Resource policy for persistent disks for creating snapshots.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\ResourcePolicySnapshotSchedulePolicy|null | |
hasSnapshotSchedulePolicy
clearSnapshotSchedulePolicy
setSnapshotSchedulePolicy
Resource policy for persistent disks for creating snapshots.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\ResourcePolicySnapshotSchedulePolicy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
[Output Only] The status of resource policy creation.
Check the Status enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatus
clearStatus
setStatus
[Output Only] The status of resource policy creation.
Check the Status enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |