Interface OSPolicyAssignmentOrBuilder (2.48.0) 

public interface OSPolicyAssignmentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBaseline()

public abstract 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];

Returns
Type Description
boolean

The baseline.

getDeleted()

public abstract boolean getDeleted()

Output only. Indicates that this revision deletes the OS policy assignment.

bool deleted = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The deleted.

getDescription()

public abstract String getDescription()

OS policy assignment description. Length of the description is limited to 1024 characters.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

OS policy assignment description. Length of the description is limited to 1024 characters.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getEtag()

public abstract 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;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for etag.

getInstanceFilter()

public abstract OSPolicyAssignment.InstanceFilter getInstanceFilter()

Required. Filter to select VMs.

.google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OSPolicyAssignment.InstanceFilter

The instanceFilter.

getInstanceFilterOrBuilder()

public abstract OSPolicyAssignment.InstanceFilterOrBuilder getInstanceFilterOrBuilder()

Required. Filter to select VMs.

.google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OSPolicyAssignment.InstanceFilterOrBuilder

getName()

public abstract 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;

Returns
Type Description
String

The name.

getNameBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for name.

getOsPolicies(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
OSPolicy

getOsPoliciesCount()

public abstract 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];

Returns
Type Description
int

getOsPoliciesList()

public abstract 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];

Returns
Type Description
List<OSPolicy>

getOsPoliciesOrBuilder(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
OSPolicyOrBuilder

getOsPoliciesOrBuilderList()

public abstract 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];

Returns
Type Description
List<? extends com.google.cloud.osconfig.v1.OSPolicyOrBuilder>

getReconciling()

public abstract 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];

Returns
Type Description
boolean

The reconciling.

getRevisionCreateTime()

public abstract Timestamp getRevisionCreateTime()

Output only. The timestamp that the revision was created.

.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

public abstract TimestampOrBuilder getRevisionCreateTimeOrBuilder()

Output only. The timestamp that the revision was created.

.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRevisionId()

public abstract 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];

Returns
Type Description
String

The revisionId.

getRevisionIdBytes()

public abstract 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];

Returns
Type Description
ByteString

The bytes for revisionId.

getRollout()

public abstract 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];

Returns
Type Description
OSPolicyAssignment.Rollout

The rollout.

getRolloutOrBuilder()

public abstract 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];

Returns
Type Description
OSPolicyAssignment.RolloutOrBuilder

getRolloutState()

public abstract 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];

Returns
Type Description
OSPolicyAssignment.RolloutState

The rolloutState.

getRolloutStateValue()

public abstract int getRolloutStateValue()

Output only. OS policy assignment rollout state

.google.cloud.osconfig.v1.OSPolicyAssignment.RolloutState rollout_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for rolloutState.

getUid()

public abstract String getUid()

Output only. Server generated unique id for the OS policy assignment resource.

string uid = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Server generated unique id for the OS policy assignment resource.

string uid = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

hasInstanceFilter()

public abstract boolean hasInstanceFilter()

Required. Filter to select VMs.

.google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the instanceFilter field is set.

hasRevisionCreateTime()

public abstract boolean hasRevisionCreateTime()

Output only. The timestamp that the revision was created.

.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the revisionCreateTime field is set.

hasRollout()

public abstract 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];

Returns
Type Description
boolean

Whether the rollout field is set.