public final class OSPolicyAssignment extends com.google.protobuf.GeneratedMessageV3 implements OSPolicyAssignmentOrBuilder
OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).Protobuf type
google.cloud.osconfig.v1.OSPolicyAssignment| Modifier and Type | Class and Description |
|---|---|
static class |
OSPolicyAssignment.Builder
OS policy assignment is an API resource that is used to
apply a set of OS policies to a dynamically targeted group of Compute Engine
VM instances.
|
static class |
OSPolicyAssignment.InstanceFilter
Filters to select target VMs for an assignment.
|
static interface |
OSPolicyAssignment.InstanceFilterOrBuilder |
static class |
OSPolicyAssignment.LabelSet
Message representing label set.
|
static interface |
OSPolicyAssignment.LabelSetOrBuilder |
static class |
OSPolicyAssignment.Rollout
Message to configure the rollout at the zonal level for the OS policy
assignment.
|
static interface |
OSPolicyAssignment.RolloutOrBuilder |
static class |
OSPolicyAssignment.RolloutState
OS policy assignment rollout state
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BASELINE_FIELD_NUMBER |
static int |
DELETED_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
ETAG_FIELD_NUMBER |
static int |
INSTANCE_FILTER_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
OS_POLICIES_FIELD_NUMBER |
static int |
RECONCILING_FIELD_NUMBER |
static int |
REVISION_CREATE_TIME_FIELD_NUMBER |
static int |
REVISION_ID_FIELD_NUMBER |
static int |
ROLLOUT_FIELD_NUMBER |
static int |
ROLLOUT_STATE_FIELD_NUMBER |
static int |
UID_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
boolean |
getBaseline()
Output only.
|
static OSPolicyAssignment |
getDefaultInstance() |
OSPolicyAssignment |
getDefaultInstanceForType() |
boolean |
getDeleted()
Output only.
|
String |
getDescription()
OS policy assignment description.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
OS policy assignment description.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEtag()
The etag for this OS policy assignment.
|
com.google.protobuf.ByteString |
getEtagBytes()
The etag for this OS policy assignment.
|
OSPolicyAssignment.InstanceFilter |
getInstanceFilter()
Required.
|
OSPolicyAssignment.InstanceFilterOrBuilder |
getInstanceFilterOrBuilder()
Required.
|
String |
getName()
Resource name.
|
com.google.protobuf.ByteString |
getNameBytes()
Resource name.
|
OSPolicy |
getOsPolicies(int index)
Required.
|
int |
getOsPoliciesCount()
Required.
|
List<OSPolicy> |
getOsPoliciesList()
Required.
|
OSPolicyOrBuilder |
getOsPoliciesOrBuilder(int index)
Required.
|
List<? extends OSPolicyOrBuilder> |
getOsPoliciesOrBuilderList()
Required.
|
com.google.protobuf.Parser<OSPolicyAssignment> |
getParserForType() |
boolean |
getReconciling()
Output only.
|
com.google.protobuf.Timestamp |
getRevisionCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getRevisionCreateTimeOrBuilder()
Output only.
|
String |
getRevisionId()
Output only.
|
com.google.protobuf.ByteString |
getRevisionIdBytes()
Output only.
|
OSPolicyAssignment.Rollout |
getRollout()
Required.
|
OSPolicyAssignment.RolloutOrBuilder |
getRolloutOrBuilder()
Required.
|
OSPolicyAssignment.RolloutState |
getRolloutState()
Output only.
|
int |
getRolloutStateValue()
Output only.
|
int |
getSerializedSize() |
String |
getUid()
Output only.
|
com.google.protobuf.ByteString |
getUidBytes()
Output only.
|
int |
hashCode() |
boolean |
hasInstanceFilter()
Required.
|
boolean |
hasRevisionCreateTime()
Output only.
|
boolean |
hasRollout()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static OSPolicyAssignment.Builder |
newBuilder() |
static OSPolicyAssignment.Builder |
newBuilder(OSPolicyAssignment prototype) |
OSPolicyAssignment.Builder |
newBuilderForType() |
protected OSPolicyAssignment.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static OSPolicyAssignment |
parseDelimitedFrom(InputStream input) |
static OSPolicyAssignment |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OSPolicyAssignment |
parseFrom(byte[] data) |
static OSPolicyAssignment |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OSPolicyAssignment |
parseFrom(ByteBuffer data) |
static OSPolicyAssignment |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OSPolicyAssignment |
parseFrom(com.google.protobuf.ByteString data) |
static OSPolicyAssignment |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OSPolicyAssignment |
parseFrom(com.google.protobuf.CodedInputStream input) |
static OSPolicyAssignment |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OSPolicyAssignment |
parseFrom(InputStream input) |
static OSPolicyAssignment |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<OSPolicyAssignment> |
parser() |
OSPolicyAssignment.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int OS_POLICIES_FIELD_NUMBER
public static final int INSTANCE_FILTER_FIELD_NUMBER
public static final int ROLLOUT_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int ROLLOUT_STATE_FIELD_NUMBER
public static final int BASELINE_FIELD_NUMBER
public static final int DELETED_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Resource name.
Format:
`projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}`
This field is ignored when you create an OS policy assignment.
string name = 1;getName in interface OSPolicyAssignmentOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Resource name.
Format:
`projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}`
This field is ignored when you create an OS policy assignment.
string name = 1;getNameBytes in interface OSPolicyAssignmentOrBuilderpublic String getDescription()
OS policy assignment description. Length of the description is limited to 1024 characters.
string description = 2;getDescription in interface OSPolicyAssignmentOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
OS policy assignment description. Length of the description is limited to 1024 characters.
string description = 2;getDescriptionBytes in interface OSPolicyAssignmentOrBuilderpublic List<OSPolicy> getOsPoliciesList()
Required. List of OS policies to be applied to the VMs.
repeated .google.cloud.osconfig.v1.OSPolicy os_policies = 3 [(.google.api.field_behavior) = REQUIRED];
getOsPoliciesList in interface OSPolicyAssignmentOrBuilderpublic List<? extends OSPolicyOrBuilder> getOsPoliciesOrBuilderList()
Required. List of OS policies to be applied to the VMs.
repeated .google.cloud.osconfig.v1.OSPolicy os_policies = 3 [(.google.api.field_behavior) = REQUIRED];
getOsPoliciesOrBuilderList in interface OSPolicyAssignmentOrBuilderpublic int getOsPoliciesCount()
Required. List of OS policies to be applied to the VMs.
repeated .google.cloud.osconfig.v1.OSPolicy os_policies = 3 [(.google.api.field_behavior) = REQUIRED];
getOsPoliciesCount in interface OSPolicyAssignmentOrBuilderpublic OSPolicy getOsPolicies(int index)
Required. List of OS policies to be applied to the VMs.
repeated .google.cloud.osconfig.v1.OSPolicy os_policies = 3 [(.google.api.field_behavior) = REQUIRED];
getOsPolicies in interface OSPolicyAssignmentOrBuilderpublic OSPolicyOrBuilder getOsPoliciesOrBuilder(int index)
Required. List of OS policies to be applied to the VMs.
repeated .google.cloud.osconfig.v1.OSPolicy os_policies = 3 [(.google.api.field_behavior) = REQUIRED];
getOsPoliciesOrBuilder in interface OSPolicyAssignmentOrBuilderpublic boolean hasInstanceFilter()
Required. Filter to select VMs.
.google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];
hasInstanceFilter in interface OSPolicyAssignmentOrBuilderpublic OSPolicyAssignment.InstanceFilter getInstanceFilter()
Required. Filter to select VMs.
.google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];
getInstanceFilter in interface OSPolicyAssignmentOrBuilderpublic OSPolicyAssignment.InstanceFilterOrBuilder getInstanceFilterOrBuilder()
Required. Filter to select VMs.
.google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];
getInstanceFilterOrBuilder in interface OSPolicyAssignmentOrBuilderpublic boolean hasRollout()
Required. Rollout to deploy the OS policy assignment.
A rollout is triggered in the following situations:
1) OSPolicyAssignment is created.
2) OSPolicyAssignment is updated and the update contains changes to one of
the following fields:
- instance_filter
- os_policies
3) OSPolicyAssignment is deleted.
.google.cloud.osconfig.v1.OSPolicyAssignment.Rollout rollout = 5 [(.google.api.field_behavior) = REQUIRED];
hasRollout in interface OSPolicyAssignmentOrBuilderpublic OSPolicyAssignment.Rollout getRollout()
Required. Rollout to deploy the OS policy assignment.
A rollout is triggered in the following situations:
1) OSPolicyAssignment is created.
2) OSPolicyAssignment is updated and the update contains changes to one of
the following fields:
- instance_filter
- os_policies
3) OSPolicyAssignment is deleted.
.google.cloud.osconfig.v1.OSPolicyAssignment.Rollout rollout = 5 [(.google.api.field_behavior) = REQUIRED];
getRollout in interface OSPolicyAssignmentOrBuilderpublic OSPolicyAssignment.RolloutOrBuilder getRolloutOrBuilder()
Required. Rollout to deploy the OS policy assignment.
A rollout is triggered in the following situations:
1) OSPolicyAssignment is created.
2) OSPolicyAssignment is updated and the update contains changes to one of
the following fields:
- instance_filter
- os_policies
3) OSPolicyAssignment is deleted.
.google.cloud.osconfig.v1.OSPolicyAssignment.Rollout rollout = 5 [(.google.api.field_behavior) = REQUIRED];
getRolloutOrBuilder in interface OSPolicyAssignmentOrBuilderpublic String getRevisionId()
Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment
string revision_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];getRevisionId in interface OSPolicyAssignmentOrBuilderpublic com.google.protobuf.ByteString getRevisionIdBytes()
Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment
string revision_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];getRevisionIdBytes in interface OSPolicyAssignmentOrBuilderpublic boolean hasRevisionCreateTime()
Output only. The timestamp that the revision was created.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasRevisionCreateTime in interface OSPolicyAssignmentOrBuilderpublic com.google.protobuf.Timestamp getRevisionCreateTime()
Output only. The timestamp that the revision was created.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRevisionCreateTime in interface OSPolicyAssignmentOrBuilderpublic com.google.protobuf.TimestampOrBuilder getRevisionCreateTimeOrBuilder()
Output only. The timestamp that the revision was created.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRevisionCreateTimeOrBuilder in interface OSPolicyAssignmentOrBuilderpublic String getEtag()
The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.
string etag = 8;getEtag in interface OSPolicyAssignmentOrBuilderpublic com.google.protobuf.ByteString getEtagBytes()
The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.
string etag = 8;getEtagBytes in interface OSPolicyAssignmentOrBuilderpublic int getRolloutStateValue()
Output only. OS policy assignment rollout state
.google.cloud.osconfig.v1.OSPolicyAssignment.RolloutState rollout_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRolloutStateValue in interface OSPolicyAssignmentOrBuilderpublic OSPolicyAssignment.RolloutState getRolloutState()
Output only. OS policy assignment rollout state
.google.cloud.osconfig.v1.OSPolicyAssignment.RolloutState rollout_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRolloutState in interface OSPolicyAssignmentOrBuilderpublic boolean getBaseline()
Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
bool baseline = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getBaseline in interface OSPolicyAssignmentOrBuilderpublic boolean getDeleted()
Output only. Indicates that this revision deletes the OS policy assignment.
bool deleted = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];getDeleted in interface OSPolicyAssignmentOrBuilderpublic boolean getReconciling()
Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING
bool reconciling = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];getReconciling in interface OSPolicyAssignmentOrBuilderpublic String getUid()
Output only. Server generated unique id for the OS policy assignment resource.
string uid = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];getUid in interface OSPolicyAssignmentOrBuilderpublic com.google.protobuf.ByteString getUidBytes()
Output only. Server generated unique id for the OS policy assignment resource.
string uid = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];getUidBytes in interface OSPolicyAssignmentOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static OSPolicyAssignment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OSPolicyAssignment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OSPolicyAssignment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OSPolicyAssignment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OSPolicyAssignment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OSPolicyAssignment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OSPolicyAssignment parseFrom(InputStream input) throws IOException
IOExceptionpublic static OSPolicyAssignment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OSPolicyAssignment parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static OSPolicyAssignment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OSPolicyAssignment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static OSPolicyAssignment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic OSPolicyAssignment.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static OSPolicyAssignment.Builder newBuilder()
public static OSPolicyAssignment.Builder newBuilder(OSPolicyAssignment prototype)
public OSPolicyAssignment.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected OSPolicyAssignment.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static OSPolicyAssignment getDefaultInstance()
public static com.google.protobuf.Parser<OSPolicyAssignment> parser()
public com.google.protobuf.Parser<OSPolicyAssignment> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public OSPolicyAssignment getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.