Package com.google.cloud.osconfig.v1

Interface OSPolicyAssignmentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    OSPolicyAssignment, OSPolicyAssignment.Builder
    public interface OSPolicyAssignmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • getDescription

        String getDescription()
         OS policy assignment description.
 Length of the description is limited to 1024 characters.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         OS policy assignment description.
 Length of the description is limited to 1024 characters.
        string description = 2;
        Returns:
        The bytes for description.

      • getOsPoliciesList

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

      • getOsPolicies

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

      • getOsPoliciesCount

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

      • getOsPoliciesOrBuilderList

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

      • getOsPoliciesOrBuilder

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

      • hasInstanceFilter

        boolean hasInstanceFilter()
         Required. Filter to select VMs.
        .google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the instanceFilter field is set.

      • getInstanceFilter

        OSPolicyAssignment.InstanceFilter getInstanceFilter()
         Required. Filter to select VMs.
        .google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The instanceFilter.

      • getInstanceFilterOrBuilder

        OSPolicyAssignment.InstanceFilterOrBuilder getInstanceFilterOrBuilder()
         Required. Filter to select VMs.
        .google.cloud.osconfig.v1.OSPolicyAssignment.InstanceFilter instance_filter = 4 [(.google.api.field_behavior) = REQUIRED];

      • hasRollout

        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:
        Whether the rollout field is set.

      • getRollout

        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:
        The rollout.

      • getRolloutOrBuilder

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

      • getRevisionId

        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:
        The revisionId.

      • getRevisionIdBytes

        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];
        Returns:
        The bytes for revisionId.

      • hasRevisionCreateTime

        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:
        Whether the revisionCreateTime field is set.

      • getRevisionCreateTime

        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];
        Returns:
        The revisionCreateTime.

      • getRevisionCreateTimeOrBuilder

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

      • getEtag

        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:
        The etag.

      • getEtagBytes

        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;
        Returns:
        The bytes for etag.

      • getRolloutStateValue

        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:
        The enum numeric value on the wire for rolloutState.

      • getRolloutState

        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:
        The rolloutState.

      • getBaseline

        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:
        The baseline.

      • getDeleted

        boolean getDeleted()
         Output only. Indicates that this revision deletes the OS policy assignment.
        bool deleted = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deleted.

      • getReconciling

        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:
        The reconciling.

      • getUid

        String getUid()
         Output only. Server generated unique id for the OS policy assignment
 resource.
        string uid = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The uid.

      • getUidBytes

        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];
        Returns:
        The bytes for uid.