Package com.google.cloud.orgpolicy.v2

Class Constraint

  • All Implemented Interfaces:
    ConstraintOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Constraint
extends com.google.protobuf.GeneratedMessageV3
implements ConstraintOrBuilder
     A `constraint` describes a way to restrict resource's configuration. For
 example, you could enforce a constraint that controls which cloud services
 can be activated across an organization, or whether a Compute Engine instance
 can have serial port connections established. `Constraints` can be configured
 by the organization's policy administrator to fit the needs of the
 organization by setting a `policy` that includes `constraints` at different
 locations in the organization's resource hierarchy. Policies are inherited
 down the resource hierarchy from higher levels, but can also be overridden.
 For details about the inheritance rules please read about
 [`policies`][google.cloud.OrgPolicy.v2.Policy].

 `Constraints` have a default behavior determined by the `constraint_default`
 field, which is the enforcement behavior that is used in the absence of a
 `policy` being defined or inherited for the resource in question.
    Protobuf type google.cloud.orgpolicy.v2.Constraint
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONSTRAINT_DEFAULT_FIELD_NUMBER

        public static final int CONSTRAINT_DEFAULT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LIST_CONSTRAINT_FIELD_NUMBER

        public static final int LIST_CONSTRAINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BOOLEAN_CONSTRAINT_FIELD_NUMBER

        public static final int BOOLEAN_CONSTRAINT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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()
         Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`

 For example, "/projects/123/constraints/compute.disableSerialPortAccess".
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface ConstraintOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`

 For example, "/projects/123/constraints/compute.disableSerialPortAccess".
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface ConstraintOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         The human readable name.

 Mutable.
        string display_name = 2;
        Specified by:
        getDisplayName in interface ConstraintOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The human readable name.

 Mutable.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface ConstraintOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.

 Mutable.
        string description = 3;
        Specified by:
        getDescription in interface ConstraintOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.

 Mutable.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface ConstraintOrBuilder
        Returns:
        The bytes for description.

      • getConstraintDefaultValue

        public int getConstraintDefaultValue()
         The evaluation behavior of this constraint in the absence of 'Policy'.
        .google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;
        Specified by:
        getConstraintDefaultValue in interface ConstraintOrBuilder
        Returns:
        The enum numeric value on the wire for constraintDefault.

      • getConstraintDefault

        public Constraint.ConstraintDefault getConstraintDefault()
         The evaluation behavior of this constraint in the absence of 'Policy'.
        .google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;
        Specified by:
        getConstraintDefault in interface ConstraintOrBuilder
        Returns:
        The constraintDefault.

      • hasListConstraint

        public boolean hasListConstraint()
         Defines this constraint as being a ListConstraint.
        .google.cloud.orgpolicy.v2.Constraint.ListConstraint list_constraint = 5;
        Specified by:
        hasListConstraint in interface ConstraintOrBuilder
        Returns:
        Whether the listConstraint field is set.

      • hasBooleanConstraint

        public boolean hasBooleanConstraint()
         Defines this constraint as being a BooleanConstraint.
        .google.cloud.orgpolicy.v2.Constraint.BooleanConstraint boolean_constraint = 6;
        Specified by:
        hasBooleanConstraint in interface ConstraintOrBuilder
        Returns:
        Whether the booleanConstraint field is set.

      • 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 Constraint parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Constraint parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Constraint getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Constraint> parser()

      • getParserForType

        public com.google.protobuf.Parser<Constraint> 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 Constraint getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder