Class PolicyBinding

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.iam.v3beta.PolicyBinding
All Implemented Interfaces:
PolicyBindingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class PolicyBinding extends com.google.protobuf.GeneratedMessage implements PolicyBindingOrBuilder
 IAM policy binding resource.
 
Protobuf type google.iam.v3beta.PolicyBinding
See Also:
  • Field Details

  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

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

      public String getName()
       Identifier. The name of the policy binding, in the format
       `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`.
       The binding parent is the closest Resource Manager resource (project,
       folder, or organization) to the binding target.
      
       Format:
      
       * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}`
       * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}`
       * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}`
       * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface PolicyBindingOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The name of the policy binding, in the format
       `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`.
       The binding parent is the closest Resource Manager resource (project,
       folder, or organization) to the binding target.
      
       Format:
      
       * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}`
       * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}`
       * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}`
       * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface PolicyBindingOrBuilder
      Returns:
      The bytes for name.
    • getUid

      public String getUid()
       Output only. The globally unique ID of the policy binding. Assigned when
       the policy binding is created.
       
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Specified by:
      getUid in interface PolicyBindingOrBuilder
      Returns:
      The uid.
    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. The globally unique ID of the policy binding. Assigned when
       the policy binding is created.
       
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Specified by:
      getUidBytes in interface PolicyBindingOrBuilder
      Returns:
      The bytes for uid.
    • getEtag

      public String getEtag()
       Optional. The etag for the policy binding.
       If this is provided on update, it must match the server's etag.
       
      string etag = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtag in interface PolicyBindingOrBuilder
      Returns:
      The etag.
    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Optional. The etag for the policy binding.
       If this is provided on update, it must match the server's etag.
       
      string etag = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtagBytes in interface PolicyBindingOrBuilder
      Returns:
      The bytes for etag.
    • getDisplayName

      public String getDisplayName()
       Optional. The description of the policy binding. Must be less than or equal
       to 63 characters.
       
      string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayName in interface PolicyBindingOrBuilder
      Returns:
      The displayName.
    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. The description of the policy binding. Must be less than or equal
       to 63 characters.
       
      string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayNameBytes in interface PolicyBindingOrBuilder
      Returns:
      The bytes for displayName.
    • getAnnotationsCount

      public int getAnnotationsCount()
      Description copied from interface: PolicyBindingOrBuilder
       Optional. User-defined annotations. See
       https://google.aip.dev/148#annotations for more details such as format and
       size limitations
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsCount in interface PolicyBindingOrBuilder
    • containsAnnotations

      public boolean containsAnnotations(String key)
       Optional. User-defined annotations. See
       https://google.aip.dev/148#annotations for more details such as format and
       size limitations
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsAnnotations in interface PolicyBindingOrBuilder
    • getAnnotations

      @Deprecated public Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.
      Specified by:
      getAnnotations in interface PolicyBindingOrBuilder
    • getAnnotationsMap

      public Map<String,String> getAnnotationsMap()
       Optional. User-defined annotations. See
       https://google.aip.dev/148#annotations for more details such as format and
       size limitations
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsMap in interface PolicyBindingOrBuilder
    • getAnnotationsOrDefault

      public String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. User-defined annotations. See
       https://google.aip.dev/148#annotations for more details such as format and
       size limitations
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrDefault in interface PolicyBindingOrBuilder
    • getAnnotationsOrThrow

      public String getAnnotationsOrThrow(String key)
       Optional. User-defined annotations. See
       https://google.aip.dev/148#annotations for more details such as format and
       size limitations
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrThrow in interface PolicyBindingOrBuilder
    • hasTarget

      public boolean hasTarget()
       Required. Immutable. The full resource name of the resource to which the
       policy will be bound. Immutable once set.
       
      .google.iam.v3beta.PolicyBinding.Target target = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasTarget in interface PolicyBindingOrBuilder
      Returns:
      Whether the target field is set.
    • getTarget

      public PolicyBinding.Target getTarget()
       Required. Immutable. The full resource name of the resource to which the
       policy will be bound. Immutable once set.
       
      .google.iam.v3beta.PolicyBinding.Target target = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTarget in interface PolicyBindingOrBuilder
      Returns:
      The target.
    • getTargetOrBuilder

      public PolicyBinding.TargetOrBuilder getTargetOrBuilder()
       Required. Immutable. The full resource name of the resource to which the
       policy will be bound. Immutable once set.
       
      .google.iam.v3beta.PolicyBinding.Target target = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTargetOrBuilder in interface PolicyBindingOrBuilder
    • getPolicyKindValue

      public int getPolicyKindValue()
       Immutable. The kind of the policy to attach in this binding. This field
       must be one of the following:
      
       - Left empty (will be automatically set to the policy kind)
       - The input policy kind
       
      .google.iam.v3beta.PolicyBinding.PolicyKind policy_kind = 11 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getPolicyKindValue in interface PolicyBindingOrBuilder
      Returns:
      The enum numeric value on the wire for policyKind.
    • getPolicyKind

      public PolicyBinding.PolicyKind getPolicyKind()
       Immutable. The kind of the policy to attach in this binding. This field
       must be one of the following:
      
       - Left empty (will be automatically set to the policy kind)
       - The input policy kind
       
      .google.iam.v3beta.PolicyBinding.PolicyKind policy_kind = 11 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getPolicyKind in interface PolicyBindingOrBuilder
      Returns:
      The policyKind.
    • getPolicy

      public String getPolicy()
       Required. Immutable. The resource name of the policy to be bound. The
       binding parent and policy must belong to the same organization.
       
      string policy = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPolicy in interface PolicyBindingOrBuilder
      Returns:
      The policy.
    • getPolicyBytes

      public com.google.protobuf.ByteString getPolicyBytes()
       Required. Immutable. The resource name of the policy to be bound. The
       binding parent and policy must belong to the same organization.
       
      string policy = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPolicyBytes in interface PolicyBindingOrBuilder
      Returns:
      The bytes for policy.
    • getPolicyUid

      public String getPolicyUid()
       Output only. The globally unique ID of the policy to be bound.
       
      string policy_uid = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPolicyUid in interface PolicyBindingOrBuilder
      Returns:
      The policyUid.
    • getPolicyUidBytes

      public com.google.protobuf.ByteString getPolicyUidBytes()
       Output only. The globally unique ID of the policy to be bound.
       
      string policy_uid = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPolicyUidBytes in interface PolicyBindingOrBuilder
      Returns:
      The bytes for policyUid.
    • hasCondition

      public boolean hasCondition()
       Optional. The condition to apply to the policy binding. When set, the
       `expression` field in the `Expr` must include from 1 to 10 subexpressions,
       joined by the
       "||"(Logical OR), "&&"(Logical AND) or "!"(Logical NOT) operators and
       cannot contain more than 250 characters.
      
       The condition is currently only supported when bound to policies of kind
       principal access boundary.
      
       When the bound policy is a principal access boundary policy, the only
       supported attributes in any subexpression are `principal.type` and
       `principal.subject`. An example expression is: "principal.type ==
       'iam.googleapis.com/ServiceAccount'" or "principal.subject ==
       'bob@example.com'".
      
       Allowed operations for `principal.subject`:
      
       - `principal.subject == <principal subject string>`
       - `principal.subject != <principal subject string>`
       - `principal.subject in [<list of principal subjects>]`
       - `principal.subject.startsWith(<string>)`
       - `principal.subject.endsWith(<string>)`
      
       Allowed operations for `principal.type`:
      
       - `principal.type == <principal type string>`
       - `principal.type != <principal type string>`
       - `principal.type in [<list of principal types>]`
      
       Supported principal types are workspace, workforce pool, workload pool,
       service account, and Agent Identity. Allowed string must be one of:
      
       - `iam.googleapis.com/WorkspaceIdentity`
       - `iam.googleapis.com/WorkforcePoolIdentity`
       - `iam.googleapis.com/WorkloadPoolIdentity`
       - `iam.googleapis.com/ServiceAccount`
       - `iam.googleapis.com/AgentPoolIdentity` (available in Preview)
       
      .google.type.Expr condition = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCondition in interface PolicyBindingOrBuilder
      Returns:
      Whether the condition field is set.
    • getCondition

      public Expr getCondition()
       Optional. The condition to apply to the policy binding. When set, the
       `expression` field in the `Expr` must include from 1 to 10 subexpressions,
       joined by the
       "||"(Logical OR), "&&"(Logical AND) or "!"(Logical NOT) operators and
       cannot contain more than 250 characters.
      
       The condition is currently only supported when bound to policies of kind
       principal access boundary.
      
       When the bound policy is a principal access boundary policy, the only
       supported attributes in any subexpression are `principal.type` and
       `principal.subject`. An example expression is: "principal.type ==
       'iam.googleapis.com/ServiceAccount'" or "principal.subject ==
       'bob@example.com'".
      
       Allowed operations for `principal.subject`:
      
       - `principal.subject == <principal subject string>`
       - `principal.subject != <principal subject string>`
       - `principal.subject in [<list of principal subjects>]`
       - `principal.subject.startsWith(<string>)`
       - `principal.subject.endsWith(<string>)`
      
       Allowed operations for `principal.type`:
      
       - `principal.type == <principal type string>`
       - `principal.type != <principal type string>`
       - `principal.type in [<list of principal types>]`
      
       Supported principal types are workspace, workforce pool, workload pool,
       service account, and Agent Identity. Allowed string must be one of:
      
       - `iam.googleapis.com/WorkspaceIdentity`
       - `iam.googleapis.com/WorkforcePoolIdentity`
       - `iam.googleapis.com/WorkloadPoolIdentity`
       - `iam.googleapis.com/ServiceAccount`
       - `iam.googleapis.com/AgentPoolIdentity` (available in Preview)
       
      .google.type.Expr condition = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCondition in interface PolicyBindingOrBuilder
      Returns:
      The condition.
    • getConditionOrBuilder

      public ExprOrBuilder getConditionOrBuilder()
       Optional. The condition to apply to the policy binding. When set, the
       `expression` field in the `Expr` must include from 1 to 10 subexpressions,
       joined by the
       "||"(Logical OR), "&&"(Logical AND) or "!"(Logical NOT) operators and
       cannot contain more than 250 characters.
      
       The condition is currently only supported when bound to policies of kind
       principal access boundary.
      
       When the bound policy is a principal access boundary policy, the only
       supported attributes in any subexpression are `principal.type` and
       `principal.subject`. An example expression is: "principal.type ==
       'iam.googleapis.com/ServiceAccount'" or "principal.subject ==
       'bob@example.com'".
      
       Allowed operations for `principal.subject`:
      
       - `principal.subject == <principal subject string>`
       - `principal.subject != <principal subject string>`
       - `principal.subject in [<list of principal subjects>]`
       - `principal.subject.startsWith(<string>)`
       - `principal.subject.endsWith(<string>)`
      
       Allowed operations for `principal.type`:
      
       - `principal.type == <principal type string>`
       - `principal.type != <principal type string>`
       - `principal.type in [<list of principal types>]`
      
       Supported principal types are workspace, workforce pool, workload pool,
       service account, and Agent Identity. Allowed string must be one of:
      
       - `iam.googleapis.com/WorkspaceIdentity`
       - `iam.googleapis.com/WorkforcePoolIdentity`
       - `iam.googleapis.com/WorkloadPoolIdentity`
       - `iam.googleapis.com/ServiceAccount`
       - `iam.googleapis.com/AgentPoolIdentity` (available in Preview)
       
      .google.type.Expr condition = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConditionOrBuilder in interface PolicyBindingOrBuilder
    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The time when the policy binding was created.
       
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface PolicyBindingOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The time when the policy binding was created.
       
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface PolicyBindingOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time when the policy binding was created.
       
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface PolicyBindingOrBuilder
    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The time when the policy binding was most recently updated.
       
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface PolicyBindingOrBuilder
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time when the policy binding was most recently updated.
       
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface PolicyBindingOrBuilder
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time when the policy binding was most recently updated.
       
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface PolicyBindingOrBuilder
    • 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 PolicyBinding parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static PolicyBinding parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static PolicyBinding parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static PolicyBinding.Builder newBuilder()
    • newBuilder

      public static PolicyBinding.Builder newBuilder(PolicyBinding prototype)
    • toBuilder

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

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

      public static PolicyBinding getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PolicyBinding> parser()
    • getParserForType

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