Package com.google.cloud.orgpolicy.v2

Class Policy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.orgpolicy.v2.Policy
All Implemented Interfaces:
PolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Policy extends com.google.protobuf.GeneratedMessage implements PolicyOrBuilder
 Defines an organization policy which is used to specify constraints
 for configurations of Google Cloud resources.
Protobuf type google.cloud.orgpolicy.v2.Policy
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Policy.Builder
    Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALTERNATE_FIELD_NUMBER
     
    static final int
    DRY_RUN_SPEC_FIELD_NUMBER
     
    static final int
    ETAG_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    SPEC_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    AlternatePolicySpec
    getAlternate()
    Deprecated.
    google.cloud.orgpolicy.v2.Policy.alternate is deprecated.
    AlternatePolicySpecOrBuilder
    getAlternateOrBuilder()
    Deprecated.
    static Policy
    getDefaultInstance()
     
    Policy
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    PolicySpec
    getDryRunSpec()
    Dry-run policy.
    PolicySpecOrBuilder
    getDryRunSpecOrBuilder()
    Dry-run policy.
    String
    getEtag()
    Optional.
    com.google.protobuf.ByteString
    getEtagBytes()
    Optional.
    String
    getName()
    Immutable.
    com.google.protobuf.ByteString
    getNameBytes()
    Immutable.
    com.google.protobuf.Parser<Policy>
    getParserForType()
     
    int
    getSerializedSize()
     
    PolicySpec
    getSpec()
    Basic information about the organization policy.
    PolicySpecOrBuilder
    getSpecOrBuilder()
    Basic information about the organization policy.
    boolean
    hasAlternate()
    Deprecated.
    google.cloud.orgpolicy.v2.Policy.alternate is deprecated.
    boolean
    hasDryRunSpec()
    Dry-run policy.
    int
    hashCode()
     
    boolean
    hasSpec()
    Basic information about the organization policy.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Policy.Builder
    newBuilder()
     
    static Policy.Builder
    newBuilder(Policy prototype)
     
    Policy.Builder
    newBuilderForType()
     
    protected Policy.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Policy
    parseDelimitedFrom(InputStream input)
     
    static Policy
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Policy
    parseFrom(byte[] data)
     
    static Policy
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Policy
    parseFrom(com.google.protobuf.ByteString data)
     
    static Policy
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Policy
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Policy
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Policy
    parseFrom(InputStream input)
     
    static Policy
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Policy
    parseFrom(ByteBuffer data)
     
    static Policy
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Policy>
    parser()
     
    Policy.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Immutable. The resource name of the policy. Must be one of the following
 forms, where `constraint_name` is the name of the constraint which this
 policy configures:

 * `projects/{project_number}/policies/{constraint_name}`
 * `folders/{folder_id}/policies/{constraint_name}`
 * `organizations/{organization_id}/policies/{constraint_name}`

 For example, `projects/123/policies/compute.disableSerialPortAccess`.

 Note: `projects/{project_id}/policies/{constraint_name}` is also an
 acceptable name for API requests, but responses will return the name using
 the equivalent project number.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getName in interface PolicyOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Immutable. The resource name of the policy. Must be one of the following
 forms, where `constraint_name` is the name of the constraint which this
 policy configures:

 * `projects/{project_number}/policies/{constraint_name}`
 * `folders/{folder_id}/policies/{constraint_name}`
 * `organizations/{organization_id}/policies/{constraint_name}`

 For example, `projects/123/policies/compute.disableSerialPortAccess`.

 Note: `projects/{project_id}/policies/{constraint_name}` is also an
 acceptable name for API requests, but responses will return the name using
 the equivalent project number.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNameBytes in interface PolicyOrBuilder
      Returns:
      The bytes for name.

    • hasSpec

      public boolean hasSpec()
       Basic information about the organization policy.
      .google.cloud.orgpolicy.v2.PolicySpec spec = 2;
      Specified by:
      hasSpec in interface PolicyOrBuilder
      Returns:
      Whether the spec field is set.

    • getSpec

      public PolicySpec getSpec()
       Basic information about the organization policy.
      .google.cloud.orgpolicy.v2.PolicySpec spec = 2;
      Specified by:
      getSpec in interface PolicyOrBuilder
      Returns:
      The spec.

    • getSpecOrBuilder

      public PolicySpecOrBuilder getSpecOrBuilder()
       Basic information about the organization policy.
      .google.cloud.orgpolicy.v2.PolicySpec spec = 2;
      Specified by:
      getSpecOrBuilder in interface PolicyOrBuilder

    • hasAlternate

      @Deprecated public boolean hasAlternate()
      Deprecated.
      google.cloud.orgpolicy.v2.Policy.alternate is deprecated. See google/cloud/orgpolicy/v2/orgpolicy.proto;l=271
       Deprecated.
      .google.cloud.orgpolicy.v2.AlternatePolicySpec alternate = 3 [deprecated = true];
      Specified by:
      hasAlternate in interface PolicyOrBuilder
      Returns:
      Whether the alternate field is set.

    • getAlternate

      @Deprecated public AlternatePolicySpec getAlternate()
      Deprecated.
      google.cloud.orgpolicy.v2.Policy.alternate is deprecated. See google/cloud/orgpolicy/v2/orgpolicy.proto;l=271
       Deprecated.
      .google.cloud.orgpolicy.v2.AlternatePolicySpec alternate = 3 [deprecated = true];
      Specified by:
      getAlternate in interface PolicyOrBuilder
      Returns:
      The alternate.

    • getAlternateOrBuilder

      @Deprecated public AlternatePolicySpecOrBuilder getAlternateOrBuilder()
      Deprecated.
       Deprecated.
      .google.cloud.orgpolicy.v2.AlternatePolicySpec alternate = 3 [deprecated = true];
      Specified by:
      getAlternateOrBuilder in interface PolicyOrBuilder

    • hasDryRunSpec

      public boolean hasDryRunSpec()
       Dry-run policy.
 Audit-only policy, can be used to monitor how the policy would have
 impacted the existing and future resources if it's enforced.
      .google.cloud.orgpolicy.v2.PolicySpec dry_run_spec = 4;
      Specified by:
      hasDryRunSpec in interface PolicyOrBuilder
      Returns:
      Whether the dryRunSpec field is set.

    • getDryRunSpec

      public PolicySpec getDryRunSpec()
       Dry-run policy.
 Audit-only policy, can be used to monitor how the policy would have
 impacted the existing and future resources if it's enforced.
      .google.cloud.orgpolicy.v2.PolicySpec dry_run_spec = 4;
      Specified by:
      getDryRunSpec in interface PolicyOrBuilder
      Returns:
      The dryRunSpec.

    • getDryRunSpecOrBuilder

      public PolicySpecOrBuilder getDryRunSpecOrBuilder()
       Dry-run policy.
 Audit-only policy, can be used to monitor how the policy would have
 impacted the existing and future resources if it's enforced.
      .google.cloud.orgpolicy.v2.PolicySpec dry_run_spec = 4;
      Specified by:
      getDryRunSpecOrBuilder in interface PolicyOrBuilder

    • getEtag

      public String getEtag()
       Optional. An opaque tag indicating the current state of the policy, used
 for concurrency control. This 'etag' is computed by the server based on the
 value of other fields, and may be sent on update and delete requests to
 ensure the client has an up-to-date value before proceeding.
      string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtag in interface PolicyOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Optional. An opaque tag indicating the current state of the policy, used
 for concurrency control. This 'etag' is computed by the server based on the
 value of other fields, and may be sent on update and delete requests to
 ensure the client has an up-to-date value before proceeding.
      string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtagBytes in interface PolicyOrBuilder
      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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Policy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Policy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Policy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Policy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Policy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Policy.Builder newBuilder()

    • newBuilder

      public static Policy.Builder newBuilder(Policy prototype)

    • toBuilder

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

    • newBuilderForType

      protected Policy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Policy getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Policy> 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.GeneratedMessage

    • getDefaultInstanceForType

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