Package com.google.cloud.osconfig.v1beta

Class GuestPolicies.GuestPolicy

  • All Implemented Interfaces:
    GuestPolicies.GuestPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    GuestPolicies
    public static final class GuestPolicies.GuestPolicy
extends com.google.protobuf.GeneratedMessageV3
implements GuestPolicies.GuestPolicyOrBuilder
     An OS Config resource representing a guest configuration policy. These
 policies represent the desired state for VM instance guest environments
 including packages to install or remove, package repository configurations,
 and software to install.
    Protobuf type google.cloud.osconfig.v1beta.GuestPolicy
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Required. Unique name of the resource in this project using one of the following
 forms:
 `projects/{project_number}/guestPolicies/{guest_policy_id}`.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. Unique name of the resource in this project using one of the following
 forms:
 `projects/{project_number}/guestPolicies/{guest_policy_id}`.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The bytes for name.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of the guest policy. Length of the description is limited
 to 1024 characters.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The bytes for description.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time this guest policy was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Time this guest policy was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time this guest policy was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface GuestPolicies.GuestPolicyOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Last time this guest policy was updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Last time this guest policy was updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Last time this guest policy was updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface GuestPolicies.GuestPolicyOrBuilder

      • hasAssignment

        public boolean hasAssignment()
         Required. Specifies the VM instances that are assigned to this policy. This allows
 you to target sets or groups of VM instances by different parameters such
 as labels, names, OS, or zones.

 If left empty, all VM instances underneath this policy are targeted.

 At the same level in the resource hierarchy (that is within a project), the
 service prevents the creation of multiple policies that conflict with
 each other. For more information, see how the service [handles assignment
 conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts).
        .google.cloud.osconfig.v1beta.Assignment assignment = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasAssignment in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        Whether the assignment field is set.

      • getAssignment

        public GuestPolicies.Assignment getAssignment()
         Required. Specifies the VM instances that are assigned to this policy. This allows
 you to target sets or groups of VM instances by different parameters such
 as labels, names, OS, or zones.

 If left empty, all VM instances underneath this policy are targeted.

 At the same level in the resource hierarchy (that is within a project), the
 service prevents the creation of multiple policies that conflict with
 each other. For more information, see how the service [handles assignment
 conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts).
        .google.cloud.osconfig.v1beta.Assignment assignment = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAssignment in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The assignment.

      • getAssignmentOrBuilder

        public GuestPolicies.AssignmentOrBuilder getAssignmentOrBuilder()
         Required. Specifies the VM instances that are assigned to this policy. This allows
 you to target sets or groups of VM instances by different parameters such
 as labels, names, OS, or zones.

 If left empty, all VM instances underneath this policy are targeted.

 At the same level in the resource hierarchy (that is within a project), the
 service prevents the creation of multiple policies that conflict with
 each other. For more information, see how the service [handles assignment
 conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts).
        .google.cloud.osconfig.v1beta.Assignment assignment = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAssignmentOrBuilder in interface GuestPolicies.GuestPolicyOrBuilder

      • getPackageRepositoriesList

        public List<GuestPolicies.PackageRepository> getPackageRepositoriesList()
         A list of package repositories to configure on the VM instance. This is
 done before any other configs are applied so they can use these repos.
 Package repositories are only configured if the corresponding package
 manager(s) are available.
        repeated .google.cloud.osconfig.v1beta.PackageRepository package_repositories = 8;
        Specified by:
        getPackageRepositoriesList in interface GuestPolicies.GuestPolicyOrBuilder

      • getPackageRepositoriesCount

        public int getPackageRepositoriesCount()
         A list of package repositories to configure on the VM instance. This is
 done before any other configs are applied so they can use these repos.
 Package repositories are only configured if the corresponding package
 manager(s) are available.
        repeated .google.cloud.osconfig.v1beta.PackageRepository package_repositories = 8;
        Specified by:
        getPackageRepositoriesCount in interface GuestPolicies.GuestPolicyOrBuilder

      • getPackageRepositories

        public GuestPolicies.PackageRepository getPackageRepositories​(int index)
         A list of package repositories to configure on the VM instance. This is
 done before any other configs are applied so they can use these repos.
 Package repositories are only configured if the corresponding package
 manager(s) are available.
        repeated .google.cloud.osconfig.v1beta.PackageRepository package_repositories = 8;
        Specified by:
        getPackageRepositories in interface GuestPolicies.GuestPolicyOrBuilder

      • getPackageRepositoriesOrBuilder

        public GuestPolicies.PackageRepositoryOrBuilder getPackageRepositoriesOrBuilder​(int index)
         A list of package repositories to configure on the VM instance. This is
 done before any other configs are applied so they can use these repos.
 Package repositories are only configured if the corresponding package
 manager(s) are available.
        repeated .google.cloud.osconfig.v1beta.PackageRepository package_repositories = 8;
        Specified by:
        getPackageRepositoriesOrBuilder in interface GuestPolicies.GuestPolicyOrBuilder

      • getEtag

        public String getEtag()
         The etag for this guest policy.
 If this is provided on update, it must match the server's etag.
        string etag = 10;
        Specified by:
        getEtag in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         The etag for this guest policy.
 If this is provided on update, it must match the server's etag.
        string etag = 10;
        Specified by:
        getEtagBytes in interface GuestPolicies.GuestPolicyOrBuilder
        Returns:
        The bytes for etag.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static GuestPolicies.GuestPolicy parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GuestPolicies.GuestPolicy parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GuestPolicies.GuestPolicy parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GuestPolicies.GuestPolicy parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GuestPolicies.GuestPolicy parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GuestPolicies.GuestPolicy parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public GuestPolicies.GuestPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public GuestPolicies.GuestPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected GuestPolicies.GuestPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<GuestPolicies.GuestPolicy> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public GuestPolicies.GuestPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder