public static final class PrincipalAccessBoundaryPolicyRule.Builder extends GeneratedMessageV3.Builder<PrincipalAccessBoundaryPolicyRule.Builder> implements PrincipalAccessBoundaryPolicyRuleOrBuilderPrincipal access boundary policy rule that defines the resource boundary.
Protobuf type google.iam.v3.PrincipalAccessBoundaryPolicyRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PrincipalAccessBoundaryPolicyRule.BuilderImplements
PrincipalAccessBoundaryPolicyRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllResources(Iterable<String> values)
public PrincipalAccessBoundaryPolicyRule.Builder addAllResources(Iterable<String> values)Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The resources to add. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PrincipalAccessBoundaryPolicyRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
addResources(String value)
public PrincipalAccessBoundaryPolicyRule.Builder addResources(String value)Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe resources to add. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
addResourcesBytes(ByteString value)
public PrincipalAccessBoundaryPolicyRule.Builder addResourcesBytes(ByteString value)Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the resources to add. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
build()
public PrincipalAccessBoundaryPolicyRule build()| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule |
|
buildPartial()
public PrincipalAccessBoundaryPolicyRule buildPartial()| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule |
|
clear()
public PrincipalAccessBoundaryPolicyRule.Builder clear()| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
clearDescription()
public PrincipalAccessBoundaryPolicyRule.Builder clearDescription()Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
clearEffect()
public PrincipalAccessBoundaryPolicyRule.Builder clearEffect()Required. The access relationship of principals to the resources in this rule.
.google.iam.v3.PrincipalAccessBoundaryPolicyRule.Effect effect = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PrincipalAccessBoundaryPolicyRule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public PrincipalAccessBoundaryPolicyRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
clearResources()
public PrincipalAccessBoundaryPolicyRule.Builder clearResources()Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
clone()
public PrincipalAccessBoundaryPolicyRule.Builder clone()| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
getDefaultInstanceForType()
public PrincipalAccessBoundaryPolicyRule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule |
|
getDescription()
public String getDescription()Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEffect()
public PrincipalAccessBoundaryPolicyRule.Effect getEffect()Required. The access relationship of principals to the resources in this rule.
.google.iam.v3.PrincipalAccessBoundaryPolicyRule.Effect effect = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Effect |
The effect. |
getEffectValue()
public int getEffectValue()Required. The access relationship of principals to the resources in this rule.
.google.iam.v3.PrincipalAccessBoundaryPolicyRule.Effect effect = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for effect. |
getResources(int index)
public String getResources(int index)Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The resources at the given index. |
getResourcesBytes(int index)
public ByteString getResourcesBytes(int index)Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the resources at the given index. |
getResourcesCount()
public int getResourcesCount()Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The count of resources. |
getResourcesList()
public ProtocolStringList getResourcesList()Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the resources. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PrincipalAccessBoundaryPolicyRule other)
public PrincipalAccessBoundaryPolicyRule.Builder mergeFrom(PrincipalAccessBoundaryPolicyRule other)| Parameter | |
|---|---|
| Name | Description |
other |
PrincipalAccessBoundaryPolicyRule |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PrincipalAccessBoundaryPolicyRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PrincipalAccessBoundaryPolicyRule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PrincipalAccessBoundaryPolicyRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
setDescription(String value)
public PrincipalAccessBoundaryPolicyRule.Builder setDescription(String value)Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public PrincipalAccessBoundaryPolicyRule.Builder setDescriptionBytes(ByteString value)Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
setEffect(PrincipalAccessBoundaryPolicyRule.Effect value)
public PrincipalAccessBoundaryPolicyRule.Builder setEffect(PrincipalAccessBoundaryPolicyRule.Effect value)Required. The access relationship of principals to the resources in this rule.
.google.iam.v3.PrincipalAccessBoundaryPolicyRule.Effect effect = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
PrincipalAccessBoundaryPolicyRule.EffectThe effect to set. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
setEffectValue(int value)
public PrincipalAccessBoundaryPolicyRule.Builder setEffectValue(int value)Required. The access relationship of principals to the resources in this rule.
.google.iam.v3.PrincipalAccessBoundaryPolicyRule.Effect effect = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for effect to set. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PrincipalAccessBoundaryPolicyRule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PrincipalAccessBoundaryPolicyRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|
setResources(int index, String value)
public PrincipalAccessBoundaryPolicyRule.Builder setResources(int index, String value)Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.
The following resource types are supported:
- Organizations, such as
//cloudresourcemanager.googleapis.com/organizations/123. - Folders, such as
//cloudresourcemanager.googleapis.com/folders/123. - Projects, such as
//cloudresourcemanager.googleapis.com/projects/123or//cloudresourcemanager.googleapis.com/projects/my-project-id.
repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe resources to set. |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final PrincipalAccessBoundaryPolicyRule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PrincipalAccessBoundaryPolicyRule.Builder |
|