Package com.google.iam.v3beta
Interface PolicyBindingOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
PolicyBinding,PolicyBinding.Builder
@Generated
public interface PolicyBindingOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanOptional.Deprecated.intOptional.Optional.getAnnotationsOrDefault(String key, String defaultValue) Optional.Optional.Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Optional.com.google.protobuf.ByteStringOptional.getEtag()Optional.com.google.protobuf.ByteStringOptional.getName()Identifier.com.google.protobuf.ByteStringIdentifier.Required.com.google.protobuf.ByteStringRequired.Immutable.intImmutable.Output only.com.google.protobuf.ByteStringOutput only.Required.Required.getUid()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOptional.booleanOutput only.booleanRequired.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
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];- Returns:
- The name.
-
getNameBytes
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];- Returns:
- The bytes for name.
-
getUid
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) = { ... }- Returns:
- The uid.
-
getUidBytes
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) = { ... }- Returns:
- The bytes for uid.
-
getEtag
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];- Returns:
- The etag.
-
getEtagBytes
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];- Returns:
- The bytes for etag.
-
getDisplayName
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];- Returns:
- The displayName.
-
getDisplayNameBytes
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];- Returns:
- The bytes for displayName.
-
getAnnotationsCount
int getAnnotationsCount()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]; -
containsAnnotations
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]; -
getAnnotations
Deprecated.UsegetAnnotationsMap()instead. -
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]; -
getAnnotationsOrDefault
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]; -
getAnnotationsOrThrow
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]; -
hasTarget
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];- Returns:
- Whether the target field is set.
-
getTarget
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];- Returns:
- The target.
-
getTargetOrBuilder
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]; -
getPolicyKindValue
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];- Returns:
- The enum numeric value on the wire for policyKind.
-
getPolicyKind
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];- Returns:
- The policyKind.
-
getPolicy
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];- Returns:
- The policy.
-
getPolicyBytes
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];- Returns:
- The bytes for policy.
-
getPolicyUid
String getPolicyUid()Output only. The globally unique ID of the policy to be bound.
string policy_uid = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The policyUid.
-
getPolicyUidBytes
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];- Returns:
- The bytes for policyUid.
-
hasCondition
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];- Returns:
- Whether the condition field is set.
-
getCondition
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];- Returns:
- The condition.
-
getConditionOrBuilder
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]; -
hasCreateTime
boolean hasCreateTime()Output only. The time when the policy binding was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
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];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
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]; -
hasUpdateTime
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];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
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];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
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];
-