Class VmExtensionPolicy (1.105.0)

public final class VmExtensionPolicy extends GeneratedMessage implements VmExtensionPolicyOrBuilder

Represents a VM extension policy.

Protobuf type google.cloud.compute.v1.VmExtensionPolicy

Static Fields

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXTENSION_POLICIES_FIELD_NUMBER

public static final int EXTENSION_POLICIES_FIELD_NUMBER
Field Value
Type Description
int
public static final int GLOBAL_RESOURCE_LINK_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_SELECTORS_FIELD_NUMBER

public static final int INSTANCE_SELECTORS_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

MANAGED_BY_GLOBAL_FIELD_NUMBER

public static final int MANAGED_BY_GLOBAL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIMESTAMP_FIELD_NUMBER

public static final int UPDATE_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VmExtensionPolicy getDefaultInstance()
Returns
Type Description
VmExtensionPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static VmExtensionPolicy.Builder newBuilder()
Returns
Type Description
VmExtensionPolicy.Builder

newBuilder(VmExtensionPolicy prototype)

public static VmExtensionPolicy.Builder newBuilder(VmExtensionPolicy prototype)
Parameter
Name Description
prototype VmExtensionPolicy
Returns
Type Description
VmExtensionPolicy.Builder

parseDelimitedFrom(InputStream input)

public static VmExtensionPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VmExtensionPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VmExtensionPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VmExtensionPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VmExtensionPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VmExtensionPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VmExtensionPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VmExtensionPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VmExtensionPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VmExtensionPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VmExtensionPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VmExtensionPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmExtensionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VmExtensionPolicy> parser()
Returns
Type Description
Parser<VmExtensionPolicy>

Methods

containsExtensionPolicies(String key)

public boolean containsExtensionPolicies(String key)

Required. A map of extension names (for example, "ops-agent") to their corresponding policy configurations.

map<string, .google.cloud.compute.v1.VmExtensionPolicyExtensionPolicy> extension_policies = 227761488;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public VmExtensionPolicy getDefaultInstanceForType()
Returns
Type Description
VmExtensionPolicy

getDescription()

public String getDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getExtensionPolicies() (deprecated)

public Map<String,VmExtensionPolicyExtensionPolicy> getExtensionPolicies()
Returns
Type Description
Map<String,VmExtensionPolicyExtensionPolicy>

getExtensionPoliciesCount()

public int getExtensionPoliciesCount()

Required. A map of extension names (for example, "ops-agent") to their corresponding policy configurations.

map<string, .google.cloud.compute.v1.VmExtensionPolicyExtensionPolicy> extension_policies = 227761488;

Returns
Type Description
int

getExtensionPoliciesMap()

public Map<String,VmExtensionPolicyExtensionPolicy> getExtensionPoliciesMap()

Required. A map of extension names (for example, "ops-agent") to their corresponding policy configurations.

map<string, .google.cloud.compute.v1.VmExtensionPolicyExtensionPolicy> extension_policies = 227761488;

Returns
Type Description
Map<String,VmExtensionPolicyExtensionPolicy>

getExtensionPoliciesOrDefault(String key, VmExtensionPolicyExtensionPolicy defaultValue)

public VmExtensionPolicyExtensionPolicy getExtensionPoliciesOrDefault(String key, VmExtensionPolicyExtensionPolicy defaultValue)

Required. A map of extension names (for example, "ops-agent") to their corresponding policy configurations.

map<string, .google.cloud.compute.v1.VmExtensionPolicyExtensionPolicy> extension_policies = 227761488;

Parameters
Name Description
key String
defaultValue VmExtensionPolicyExtensionPolicy
Returns
Type Description
VmExtensionPolicyExtensionPolicy

getExtensionPoliciesOrThrow(String key)

public VmExtensionPolicyExtensionPolicy getExtensionPoliciesOrThrow(String key)

Required. A map of extension names (for example, "ops-agent") to their corresponding policy configurations.

map<string, .google.cloud.compute.v1.VmExtensionPolicyExtensionPolicy> extension_policies = 227761488;

Parameter
Name Description
key String
Returns
Type Description
VmExtensionPolicyExtensionPolicy
public String getGlobalResourceLink()

Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if applicable.

optional string global_resource_link = 516569583;

Returns
Type Description
String

The globalResourceLink.

getGlobalResourceLinkBytes()

public ByteString getGlobalResourceLinkBytes()

Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if applicable.

optional string global_resource_link = 516569583;

Returns
Type Description
ByteString

The bytes for globalResourceLink.

getId()

public long getId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getInstanceSelectors(int index)

public VmExtensionPolicyInstanceSelector getInstanceSelectors(int index)

Optional. Selectors to target VMs for this policy. VMs are selected if they match any of the provided selectors (logical OR). If this list is empty, the policy applies to all VMs.

repeated .google.cloud.compute.v1.VmExtensionPolicyInstanceSelector instance_selectors = 520298826;

Parameter
Name Description
index int
Returns
Type Description
VmExtensionPolicyInstanceSelector

getInstanceSelectorsCount()

public int getInstanceSelectorsCount()

Optional. Selectors to target VMs for this policy. VMs are selected if they match any of the provided selectors (logical OR). If this list is empty, the policy applies to all VMs.

repeated .google.cloud.compute.v1.VmExtensionPolicyInstanceSelector instance_selectors = 520298826;

Returns
Type Description
int

getInstanceSelectorsList()

public List<VmExtensionPolicyInstanceSelector> getInstanceSelectorsList()

Optional. Selectors to target VMs for this policy. VMs are selected if they match any of the provided selectors (logical OR). If this list is empty, the policy applies to all VMs.

repeated .google.cloud.compute.v1.VmExtensionPolicyInstanceSelector instance_selectors = 520298826;

Returns
Type Description
List<VmExtensionPolicyInstanceSelector>

getInstanceSelectorsOrBuilder(int index)

public VmExtensionPolicyInstanceSelectorOrBuilder getInstanceSelectorsOrBuilder(int index)

Optional. Selectors to target VMs for this policy. VMs are selected if they match any of the provided selectors (logical OR). If this list is empty, the policy applies to all VMs.

repeated .google.cloud.compute.v1.VmExtensionPolicyInstanceSelector instance_selectors = 520298826;

Parameter
Name Description
index int
Returns
Type Description
VmExtensionPolicyInstanceSelectorOrBuilder

getInstanceSelectorsOrBuilderList()

public List<? extends VmExtensionPolicyInstanceSelectorOrBuilder> getInstanceSelectorsOrBuilderList()

Optional. Selectors to target VMs for this policy. VMs are selected if they match any of the provided selectors (logical OR). If this list is empty, the policy applies to all VMs.

repeated .google.cloud.compute.v1.VmExtensionPolicyInstanceSelector instance_selectors = 520298826;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.VmExtensionPolicyInstanceSelectorOrBuilder>

getKind()

public String getKind()

Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getManagedByGlobal()

public boolean getManagedByGlobal()

Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.

optional bool managed_by_global = 88605675;

Returns
Type Description
boolean

The managedByGlobal.

getName()

public String 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? 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.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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? 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.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<VmExtensionPolicy> getParserForType()
Returns
Type Description
Parser<VmExtensionPolicy>
Overrides

getPriority()

public int getPriority()

Optional. Priority of this policy. Used to resolve conflicts when multiple policies apply to the same extension. The policy priority is an integer from 0 to 65535, inclusive. Lower integers indicate higher priorities. If you do not specify a priority when creating a rule, it is assigned a priority of 1000. If priorities are equal, the policy with the most recent creation timestamp takes precedence.

optional int32 priority = 445151652;

Returns
Type Description
int

The priority.

public String getSelfLink()

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public String getSelfLinkWithId()

Output only. [Output Only] Server-defined URL for this resource's resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public ByteString getSelfLinkWithIdBytes()

Output only. [Output Only] Server-defined URL for this resource's resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public String getState()

Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING. Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING. Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
ByteString

The bytes for state.

getUpdateTimestamp()

public String getUpdateTimestamp()

Output only. [Output Only] Update timestamp inRFC3339 text format.

optional string update_timestamp = 120894752;

Returns
Type Description
String

The updateTimestamp.

getUpdateTimestampBytes()

public ByteString getUpdateTimestampBytes()

Output only. [Output Only] Update timestamp inRFC3339 text format.

optional string update_timestamp = 120894752;

Returns
Type Description
ByteString

The bytes for updateTimestamp.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

public boolean hasGlobalResourceLink()

Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if applicable.

optional string global_resource_link = 516569583;

Returns
Type Description
boolean

Whether the globalResourceLink field is set.

hasId()

public boolean hasId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasManagedByGlobal()

public boolean hasManagedByGlobal()

Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.

optional bool managed_by_global = 88605675;

Returns
Type Description
boolean

Whether the managedByGlobal field is set.

hasName()

public boolean hasName()

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? 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.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasPriority()

public boolean hasPriority()

Optional. Priority of this policy. Used to resolve conflicts when multiple policies apply to the same extension. The policy priority is an integer from 0 to 65535, inclusive. Lower integers indicate higher priorities. If you do not specify a priority when creating a rule, it is assigned a priority of 1000. If priorities are equal, the policy with the most recent creation timestamp takes precedence.

optional int32 priority = 445151652;

Returns
Type Description
boolean

Whether the priority field is set.

public boolean hasSelfLink()

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSelfLinkWithId()

public boolean hasSelfLinkWithId()

Output only. [Output Only] Server-defined URL for this resource's resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
boolean

Whether the selfLinkWithId field is set.

hasState()

public boolean hasState()

Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING. Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
boolean

Whether the state field is set.

hasUpdateTimestamp()

public boolean hasUpdateTimestamp()

Output only. [Output Only] Update timestamp inRFC3339 text format.

optional string update_timestamp = 120894752;

Returns
Type Description
boolean

Whether the updateTimestamp field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VmExtensionPolicy.Builder newBuilderForType()
Returns
Type Description
VmExtensionPolicy.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected VmExtensionPolicy.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VmExtensionPolicy.Builder
Overrides

toBuilder()

public VmExtensionPolicy.Builder toBuilder()
Returns
Type Description
VmExtensionPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException