Reference documentation and code samples for the Compute V1 Client class GlobalVmExtensionPolicy.
Message describing GlobalVmExtensionPolicy object.
Generated from protobuf message google.cloud.compute.v1.GlobalVmExtensionPolicy
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ creation_timestamp |
string
Output only. [Output Only] Creation timestamp inRFC3339 text format. |
↳ description |
string
An optional description of this resource. Provide this property when you create the resource. |
↳ extension_policies |
array|Google\Protobuf\Internal\MapField
Required. Map from extension (eg: "cloudops") to its policy configuration. The key is the name of the extension. |
↳ id |
int|string
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
↳ instance_selectors |
array<GlobalVmExtensionPolicyInstanceSelector>
Optional. Selector to target VMs for a policy. There is a logical "AND" between instance_selectors. |
↳ kind |
string
Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies. |
↳ name |
string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
↳ priority |
int
Optional. Used to resolve conflicts when multiple policies are active for the same extension. Defaults to 0. Larger the number, higher the priority. When the priority is the same, the policy with the newer create time has higher priority. |
↳ rollout_operation |
GlobalVmExtensionPolicyRolloutOperation
Required. The rollout strategy and status. |
↳ scoped_resource_status |
string
Output only. [Output Only] The scoped resource status. It's only for tracking the purging status of the policy. Check the ScopedResourceStatus enum for the list of possible values. |
↳ self_link |
string
Output only. [Output Only] Server-defined fully-qualified URL for this resource. |
↳ self_link_with_id |
string
Output only. [Output Only] Server-defined URL for this resource's resource id. |
↳ update_timestamp |
string
Output only. [Output Only] Update timestamp inRFC3339 text format. |
getCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
An optional description of this resource. Provide this property when you create the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExtensionPolicies
Required. Map from extension (eg: "cloudops") to its policy configuration.
The key is the name of the extension.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setExtensionPolicies
Required. Map from extension (eg: "cloudops") to its policy configuration.
The key is the name of the extension.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Output only. [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. [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 |
|
getInstanceSelectors
Optional. Selector to target VMs for a policy.
There is a logical "AND" between instance_selectors.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<GlobalVmExtensionPolicyInstanceSelector> |
|
setInstanceSelectors
Optional. Selector to target VMs for a policy.
There is a logical "AND" between instance_selectors.
| Parameter | |
|---|---|
| Name | Description |
var |
array<GlobalVmExtensionPolicyInstanceSelector>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKind
clearKind
setKind
Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Name of the resource. Provided by the client when the resource is created.
The name must be 1-63 characters long, and comply withRFC1035.
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
Name of the resource. Provided by the client when the resource is created.
The name must be 1-63 characters long, and comply withRFC1035.
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 |
|
getPriority
Optional. Used to resolve conflicts when multiple policies are active for the same extension. Defaults to 0.
Larger the number, higher the priority. When the priority is the same, the policy with the newer create time has higher priority.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasPriority
clearPriority
setPriority
Optional. Used to resolve conflicts when multiple policies are active for the same extension. Defaults to 0.
Larger the number, higher the priority. When the priority is the same, the policy with the newer create time has higher priority.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRolloutOperation
Required. The rollout strategy and status.
| Returns | |
|---|---|
| Type | Description |
GlobalVmExtensionPolicyRolloutOperation|null |
|
hasRolloutOperation
clearRolloutOperation
setRolloutOperation
Required. The rollout strategy and status.
| Parameter | |
|---|---|
| Name | Description |
var |
GlobalVmExtensionPolicyRolloutOperation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScopedResourceStatus
Output only. [Output Only] The scoped resource status. It's only for tracking the purging status of the policy.
Check the ScopedResourceStatus enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasScopedResourceStatus
clearScopedResourceStatus
setScopedResourceStatus
Output only. [Output Only] The scoped resource status. It's only for tracking the purging status of the policy.
Check the ScopedResourceStatus enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
Output only. [Output Only] Server-defined fully-qualified URL for this resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLink
clearSelfLink
setSelfLink
Output only. [Output Only] Server-defined fully-qualified URL for this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLinkWithId
Output only. [Output Only] Server-defined URL for this resource's resource id.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
Output only. [Output Only] Server-defined URL for this resource's resource id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTimestamp
Output only. [Output Only] Update timestamp inRFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasUpdateTimestamp
clearUpdateTimestamp
setUpdateTimestamp
Output only. [Output Only] Update timestamp inRFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|