Class BucketAccessControl.Builder (2.37.0)

public static final class BucketAccessControl.Builder extends GeneratedMessageV3.Builder<BucketAccessControl.Builder> implements BucketAccessControlOrBuilder

An access-control entry.

Protobuf type google.storage.v2.BucketAccessControl

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BucketAccessControl.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BucketAccessControl.Builder
Overrides

build()

public BucketAccessControl build()
Returns
Type Description
BucketAccessControl

buildPartial()

public BucketAccessControl buildPartial()
Returns
Type Description
BucketAccessControl

clear()

public BucketAccessControl.Builder clear()
Returns
Type Description
BucketAccessControl.Builder
Overrides

clearDomain()

public BucketAccessControl.Builder clearDomain()

The domain associated with the entity, if any.

string domain = 6;

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clearEmail()

public BucketAccessControl.Builder clearEmail()

The email address associated with the entity, if any.

string email = 5;

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clearEntity()

public BucketAccessControl.Builder clearEntity()

The entity holding the permission, in one of the following forms:

  • user-{userid}
  • user-{email}
  • group-{groupid}
  • group-{email}
  • domain-{domain}
  • project-{team}-{projectnumber}
  • project-{team}-{projectid}
  • allUsers
  • allAuthenticatedUsers Examples:
  • The user liz@example.com would be user-liz@example.com.
  • The group example@googlegroups.com would be group-example@googlegroups.com
  • All members of the Google Apps for Business domain example.com would be domain-example.com For project entities, project-{team}-{projectnumber} format will be returned on response.

string entity = 3;

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clearEntityAlt()

public BucketAccessControl.Builder clearEntityAlt()

Output only. The alternative entity format, if exists. For project entities, project-{team}-{projectid} format will be returned on response.

string entity_alt = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clearEntityId()

public BucketAccessControl.Builder clearEntityId()

The ID for the entity, if any.

string entity_id = 4;

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clearEtag()

public BucketAccessControl.Builder clearEtag()

The etag of the BucketAccessControl. If included in the metadata of an update or delete request message, the operation operation will only be performed if the etag matches that of the bucket's BucketAccessControl.

string etag = 8;

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BucketAccessControl.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BucketAccessControl.Builder
Overrides

clearId()

public BucketAccessControl.Builder clearId()

The ID of the access-control entry.

string id = 2;

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BucketAccessControl.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BucketAccessControl.Builder
Overrides

clearProjectTeam()

public BucketAccessControl.Builder clearProjectTeam()

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Returns
Type Description
BucketAccessControl.Builder

clearRole()

public BucketAccessControl.Builder clearRole()

The access permission for the entity.

string role = 1;

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

clone()

public BucketAccessControl.Builder clone()
Returns
Type Description
BucketAccessControl.Builder
Overrides

getDefaultInstanceForType()

public BucketAccessControl getDefaultInstanceForType()
Returns
Type Description
BucketAccessControl

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDomain()

public String getDomain()

The domain associated with the entity, if any.

string domain = 6;

Returns
Type Description
String

The domain.

getDomainBytes()

public ByteString getDomainBytes()

The domain associated with the entity, if any.

string domain = 6;

Returns
Type Description
ByteString

The bytes for domain.

getEmail()

public String getEmail()

The email address associated with the entity, if any.

string email = 5;

Returns
Type Description
String

The email.

getEmailBytes()

public ByteString getEmailBytes()

The email address associated with the entity, if any.

string email = 5;

Returns
Type Description
ByteString

The bytes for email.

getEntity()

public String getEntity()

The entity holding the permission, in one of the following forms:

  • user-{userid}
  • user-{email}
  • group-{groupid}
  • group-{email}
  • domain-{domain}
  • project-{team}-{projectnumber}
  • project-{team}-{projectid}
  • allUsers
  • allAuthenticatedUsers Examples:
  • The user liz@example.com would be user-liz@example.com.
  • The group example@googlegroups.com would be group-example@googlegroups.com
  • All members of the Google Apps for Business domain example.com would be domain-example.com For project entities, project-{team}-{projectnumber} format will be returned on response.

string entity = 3;

Returns
Type Description
String

The entity.

getEntityAlt()

public String getEntityAlt()

Output only. The alternative entity format, if exists. For project entities, project-{team}-{projectid} format will be returned on response.

string entity_alt = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The entityAlt.

getEntityAltBytes()

public ByteString getEntityAltBytes()

Output only. The alternative entity format, if exists. For project entities, project-{team}-{projectid} format will be returned on response.

string entity_alt = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for entityAlt.

getEntityBytes()

public ByteString getEntityBytes()

The entity holding the permission, in one of the following forms:

  • user-{userid}
  • user-{email}
  • group-{groupid}
  • group-{email}
  • domain-{domain}
  • project-{team}-{projectnumber}
  • project-{team}-{projectid}
  • allUsers
  • allAuthenticatedUsers Examples:
  • The user liz@example.com would be user-liz@example.com.
  • The group example@googlegroups.com would be group-example@googlegroups.com
  • All members of the Google Apps for Business domain example.com would be domain-example.com For project entities, project-{team}-{projectnumber} format will be returned on response.

string entity = 3;

Returns
Type Description
ByteString

The bytes for entity.

getEntityId()

public String getEntityId()

The ID for the entity, if any.

string entity_id = 4;

Returns
Type Description
String

The entityId.

getEntityIdBytes()

public ByteString getEntityIdBytes()

The ID for the entity, if any.

string entity_id = 4;

Returns
Type Description
ByteString

The bytes for entityId.

getEtag()

public String getEtag()

The etag of the BucketAccessControl. If included in the metadata of an update or delete request message, the operation operation will only be performed if the etag matches that of the bucket's BucketAccessControl.

string etag = 8;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

The etag of the BucketAccessControl. If included in the metadata of an update or delete request message, the operation operation will only be performed if the etag matches that of the bucket's BucketAccessControl.

string etag = 8;

Returns
Type Description
ByteString

The bytes for etag.

getId()

public String getId()

The ID of the access-control entry.

string id = 2;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

The ID of the access-control entry.

string id = 2;

Returns
Type Description
ByteString

The bytes for id.

getProjectTeam()

public ProjectTeam getProjectTeam()

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Returns
Type Description
ProjectTeam

The projectTeam.

getProjectTeamBuilder()

public ProjectTeam.Builder getProjectTeamBuilder()

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Returns
Type Description
ProjectTeam.Builder

getProjectTeamOrBuilder()

public ProjectTeamOrBuilder getProjectTeamOrBuilder()

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Returns
Type Description
ProjectTeamOrBuilder

getRole()

public String getRole()

The access permission for the entity.

string role = 1;

Returns
Type Description
String

The role.

getRoleBytes()

public ByteString getRoleBytes()

The access permission for the entity.

string role = 1;

Returns
Type Description
ByteString

The bytes for role.

hasProjectTeam()

public boolean hasProjectTeam()

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Returns
Type Description
boolean

Whether the projectTeam field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BucketAccessControl.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BucketAccessControl.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BucketAccessControl.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BucketAccessControl.Builder
Overrides

mergeFrom(BucketAccessControl other)

public BucketAccessControl.Builder mergeFrom(BucketAccessControl other)
Parameter
Name Description
other BucketAccessControl
Returns
Type Description
BucketAccessControl.Builder

mergeProjectTeam(ProjectTeam value)

public BucketAccessControl.Builder mergeProjectTeam(ProjectTeam value)

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Parameter
Name Description
value ProjectTeam
Returns
Type Description
BucketAccessControl.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BucketAccessControl.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BucketAccessControl.Builder
Overrides

setDomain(String value)

public BucketAccessControl.Builder setDomain(String value)

The domain associated with the entity, if any.

string domain = 6;

Parameter
Name Description
value String

The domain to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setDomainBytes(ByteString value)

public BucketAccessControl.Builder setDomainBytes(ByteString value)

The domain associated with the entity, if any.

string domain = 6;

Parameter
Name Description
value ByteString

The bytes for domain to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEmail(String value)

public BucketAccessControl.Builder setEmail(String value)

The email address associated with the entity, if any.

string email = 5;

Parameter
Name Description
value String

The email to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEmailBytes(ByteString value)

public BucketAccessControl.Builder setEmailBytes(ByteString value)

The email address associated with the entity, if any.

string email = 5;

Parameter
Name Description
value ByteString

The bytes for email to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEntity(String value)

public BucketAccessControl.Builder setEntity(String value)

The entity holding the permission, in one of the following forms:

  • user-{userid}
  • user-{email}
  • group-{groupid}
  • group-{email}
  • domain-{domain}
  • project-{team}-{projectnumber}
  • project-{team}-{projectid}
  • allUsers
  • allAuthenticatedUsers Examples:
  • The user liz@example.com would be user-liz@example.com.
  • The group example@googlegroups.com would be group-example@googlegroups.com
  • All members of the Google Apps for Business domain example.com would be domain-example.com For project entities, project-{team}-{projectnumber} format will be returned on response.

string entity = 3;

Parameter
Name Description
value String

The entity to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEntityAlt(String value)

public BucketAccessControl.Builder setEntityAlt(String value)

Output only. The alternative entity format, if exists. For project entities, project-{team}-{projectid} format will be returned on response.

string entity_alt = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The entityAlt to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEntityAltBytes(ByteString value)

public BucketAccessControl.Builder setEntityAltBytes(ByteString value)

Output only. The alternative entity format, if exists. For project entities, project-{team}-{projectid} format will be returned on response.

string entity_alt = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for entityAlt to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEntityBytes(ByteString value)

public BucketAccessControl.Builder setEntityBytes(ByteString value)

The entity holding the permission, in one of the following forms:

  • user-{userid}
  • user-{email}
  • group-{groupid}
  • group-{email}
  • domain-{domain}
  • project-{team}-{projectnumber}
  • project-{team}-{projectid}
  • allUsers
  • allAuthenticatedUsers Examples:
  • The user liz@example.com would be user-liz@example.com.
  • The group example@googlegroups.com would be group-example@googlegroups.com
  • All members of the Google Apps for Business domain example.com would be domain-example.com For project entities, project-{team}-{projectnumber} format will be returned on response.

string entity = 3;

Parameter
Name Description
value ByteString

The bytes for entity to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEntityId(String value)

public BucketAccessControl.Builder setEntityId(String value)

The ID for the entity, if any.

string entity_id = 4;

Parameter
Name Description
value String

The entityId to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEntityIdBytes(ByteString value)

public BucketAccessControl.Builder setEntityIdBytes(ByteString value)

The ID for the entity, if any.

string entity_id = 4;

Parameter
Name Description
value ByteString

The bytes for entityId to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEtag(String value)

public BucketAccessControl.Builder setEtag(String value)

The etag of the BucketAccessControl. If included in the metadata of an update or delete request message, the operation operation will only be performed if the etag matches that of the bucket's BucketAccessControl.

string etag = 8;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public BucketAccessControl.Builder setEtagBytes(ByteString value)

The etag of the BucketAccessControl. If included in the metadata of an update or delete request message, the operation operation will only be performed if the etag matches that of the bucket's BucketAccessControl.

string etag = 8;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BucketAccessControl.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BucketAccessControl.Builder
Overrides

setId(String value)

public BucketAccessControl.Builder setId(String value)

The ID of the access-control entry.

string id = 2;

Parameter
Name Description
value String

The id to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setIdBytes(ByteString value)

public BucketAccessControl.Builder setIdBytes(ByteString value)

The ID of the access-control entry.

string id = 2;

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setProjectTeam(ProjectTeam value)

public BucketAccessControl.Builder setProjectTeam(ProjectTeam value)

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Parameter
Name Description
value ProjectTeam
Returns
Type Description
BucketAccessControl.Builder

setProjectTeam(ProjectTeam.Builder builderForValue)

public BucketAccessControl.Builder setProjectTeam(ProjectTeam.Builder builderForValue)

The project team associated with the entity, if any.

.google.storage.v2.ProjectTeam project_team = 7;

Parameter
Name Description
builderForValue ProjectTeam.Builder
Returns
Type Description
BucketAccessControl.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BucketAccessControl.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BucketAccessControl.Builder
Overrides

setRole(String value)

public BucketAccessControl.Builder setRole(String value)

The access permission for the entity.

string role = 1;

Parameter
Name Description
value String

The role to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setRoleBytes(ByteString value)

public BucketAccessControl.Builder setRoleBytes(ByteString value)

The access permission for the entity.

string role = 1;

Parameter
Name Description
value ByteString

The bytes for role to set.

Returns
Type Description
BucketAccessControl.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BucketAccessControl.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BucketAccessControl.Builder
Overrides