Class GuestPolicies.Assignment (2.47.0)

public static final class GuestPolicies.Assignment extends GeneratedMessageV3 implements GuestPolicies.AssignmentOrBuilder

An assignment represents the group or groups of VM instances that the policy applies to.

If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.

Protobuf type google.cloud.osconfig.v1beta.Assignment

Static Fields

GROUP_LABELS_FIELD_NUMBER

public static final int GROUP_LABELS_FIELD_NUMBER
Field Value
Type Description
int

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_NAME_PREFIXES_FIELD_NUMBER

public static final int INSTANCE_NAME_PREFIXES_FIELD_NUMBER
Field Value
Type Description
int

OS_TYPES_FIELD_NUMBER

public static final int OS_TYPES_FIELD_NUMBER
Field Value
Type Description
int

ZONES_FIELD_NUMBER

public static final int ZONES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GuestPolicies.Assignment getDefaultInstance()
Returns
Type Description
GuestPolicies.Assignment

getDescriptor()

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

newBuilder()

public static GuestPolicies.Assignment.Builder newBuilder()
Returns
Type Description
GuestPolicies.Assignment.Builder

newBuilder(GuestPolicies.Assignment prototype)

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

parseDelimitedFrom(InputStream input)

public static GuestPolicies.Assignment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GuestPolicies.Assignment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static GuestPolicies.Assignment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GuestPolicies.Assignment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static GuestPolicies.Assignment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GuestPolicies.Assignment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static GuestPolicies.Assignment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GuestPolicies.Assignment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static GuestPolicies.Assignment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GuestPolicies.Assignment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<GuestPolicies.Assignment> parser()
Returns
Type Description
Parser<Assignment>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GuestPolicies.Assignment getDefaultInstanceForType()
Returns
Type Description
GuestPolicies.Assignment

getGroupLabels(int index)

public GuestPolicies.Assignment.GroupLabel getGroupLabels(int index)

Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.Assignment.GroupLabel group_labels = 1;

Parameter
Name Description
index int
Returns
Type Description
GuestPolicies.Assignment.GroupLabel

getGroupLabelsCount()

public int getGroupLabelsCount()

Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.Assignment.GroupLabel group_labels = 1;

Returns
Type Description
int

getGroupLabelsList()

public List<GuestPolicies.Assignment.GroupLabel> getGroupLabelsList()

Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.Assignment.GroupLabel group_labels = 1;

Returns
Type Description
List<GroupLabel>

getGroupLabelsOrBuilder(int index)

public GuestPolicies.Assignment.GroupLabelOrBuilder getGroupLabelsOrBuilder(int index)

Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.Assignment.GroupLabel group_labels = 1;

Parameter
Name Description
index int
Returns
Type Description
GuestPolicies.Assignment.GroupLabelOrBuilder

getGroupLabelsOrBuilderList()

public List<? extends GuestPolicies.Assignment.GroupLabelOrBuilder> getGroupLabelsOrBuilderList()

Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.Assignment.GroupLabel group_labels = 1;

Returns
Type Description
List<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.Assignment.GroupLabelOrBuilder>

getInstanceNamePrefixes(int index)

public String getInstanceNamePrefixes(int index)

Targets VM instances whose name starts with one of these prefixes.

Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-".

Only supported for project-level policies.

repeated string instance_name_prefixes = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The instanceNamePrefixes at the given index.

getInstanceNamePrefixesBytes(int index)

public ByteString getInstanceNamePrefixesBytes(int index)

Targets VM instances whose name starts with one of these prefixes.

Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-".

Only supported for project-level policies.

repeated string instance_name_prefixes = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the instanceNamePrefixes at the given index.

getInstanceNamePrefixesCount()

public int getInstanceNamePrefixesCount()

Targets VM instances whose name starts with one of these prefixes.

Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-".

Only supported for project-level policies.

repeated string instance_name_prefixes = 4;

Returns
Type Description
int

The count of instanceNamePrefixes.

getInstanceNamePrefixesList()

public ProtocolStringList getInstanceNamePrefixesList()

Targets VM instances whose name starts with one of these prefixes.

Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-".

Only supported for project-level policies.

repeated string instance_name_prefixes = 4;

Returns
Type Description
ProtocolStringList

A list containing the instanceNamePrefixes.

getInstances(int index)

public String getInstances(int index)

Targets any of the instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME].

Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing.

Only supported for project-level policies and must reference instances within this project.

repeated string instances = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The instances at the given index.

getInstancesBytes(int index)

public ByteString getInstancesBytes(int index)

Targets any of the instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME].

Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing.

Only supported for project-level policies and must reference instances within this project.

repeated string instances = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the instances at the given index.

getInstancesCount()

public int getInstancesCount()

Targets any of the instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME].

Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing.

Only supported for project-level policies and must reference instances within this project.

repeated string instances = 3;

Returns
Type Description
int

The count of instances.

getInstancesList()

public ProtocolStringList getInstancesList()

Targets any of the instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME].

Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing.

Only supported for project-level policies and must reference instances within this project.

repeated string instances = 3;

Returns
Type Description
ProtocolStringList

A list containing the instances.

getOsTypes(int index)

public GuestPolicies.Assignment.OsType getOsTypes(int index)

Targets VM instances matching at least one of the following OS types.

VM instances must match all supplied criteria for a given OsType to be included.

repeated .google.cloud.osconfig.v1beta.Assignment.OsType os_types = 5;

Parameter
Name Description
index int
Returns
Type Description
GuestPolicies.Assignment.OsType

getOsTypesCount()

public int getOsTypesCount()

Targets VM instances matching at least one of the following OS types.

VM instances must match all supplied criteria for a given OsType to be included.

repeated .google.cloud.osconfig.v1beta.Assignment.OsType os_types = 5;

Returns
Type Description
int

getOsTypesList()

public List<GuestPolicies.Assignment.OsType> getOsTypesList()

Targets VM instances matching at least one of the following OS types.

VM instances must match all supplied criteria for a given OsType to be included.

repeated .google.cloud.osconfig.v1beta.Assignment.OsType os_types = 5;

Returns
Type Description
List<OsType>

getOsTypesOrBuilder(int index)

public GuestPolicies.Assignment.OsTypeOrBuilder getOsTypesOrBuilder(int index)

Targets VM instances matching at least one of the following OS types.

VM instances must match all supplied criteria for a given OsType to be included.

repeated .google.cloud.osconfig.v1beta.Assignment.OsType os_types = 5;

Parameter
Name Description
index int
Returns
Type Description
GuestPolicies.Assignment.OsTypeOrBuilder

getOsTypesOrBuilderList()

public List<? extends GuestPolicies.Assignment.OsTypeOrBuilder> getOsTypesOrBuilderList()

Targets VM instances matching at least one of the following OS types.

VM instances must match all supplied criteria for a given OsType to be included.

repeated .google.cloud.osconfig.v1beta.Assignment.OsType os_types = 5;

Returns
Type Description
List<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.Assignment.OsTypeOrBuilder>

getParserForType()

public Parser<GuestPolicies.Assignment> getParserForType()
Returns
Type Description
Parser<Assignment>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getZones(int index)

public String getZones(int index)

Targets instances in any of these zones. Leave empty to target instances in any zone.

Zonal targeting is uncommon and is supported to facilitate the management of changes by zone.

repeated string zones = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The zones at the given index.

getZonesBytes(int index)

public ByteString getZonesBytes(int index)

Targets instances in any of these zones. Leave empty to target instances in any zone.

Zonal targeting is uncommon and is supported to facilitate the management of changes by zone.

repeated string zones = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the zones at the given index.

getZonesCount()

public int getZonesCount()

Targets instances in any of these zones. Leave empty to target instances in any zone.

Zonal targeting is uncommon and is supported to facilitate the management of changes by zone.

repeated string zones = 2;

Returns
Type Description
int

The count of zones.

getZonesList()

public ProtocolStringList getZonesList()

Targets instances in any of these zones. Leave empty to target instances in any zone.

Zonal targeting is uncommon and is supported to facilitate the management of changes by zone.

repeated string zones = 2;

Returns
Type Description
ProtocolStringList

A list containing the zones.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GuestPolicies.Assignment.Builder newBuilderForType()
Returns
Type Description
GuestPolicies.Assignment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GuestPolicies.Assignment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GuestPolicies.Assignment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GuestPolicies.Assignment.Builder toBuilder()
Returns
Type Description
GuestPolicies.Assignment.Builder

writeTo(CodedOutputStream output)

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