public static final class ObjectAccessControl.Builder extends GeneratedMessageV3.Builder<ObjectAccessControl.Builder> implements ObjectAccessControlOrBuilder
An access-control entry.
Protobuf type google.storage.v2.ObjectAccessControl
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ObjectAccessControl.BuilderImplements
ObjectAccessControlOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ObjectAccessControl.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
build()
public ObjectAccessControl build()
Returns | |
---|---|
Type | Description |
ObjectAccessControl |
buildPartial()
public ObjectAccessControl buildPartial()
Returns | |
---|---|
Type | Description |
ObjectAccessControl |
clear()
public ObjectAccessControl.Builder clear()
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
clearDomain()
public ObjectAccessControl.Builder clearDomain()
The domain associated with the entity, if any.
string domain = 6;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
clearEmail()
public ObjectAccessControl.Builder clearEmail()
The email address associated with the entity, if any.
string email = 5;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
clearEntity()
public ObjectAccessControl.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 beuser-liz@example.com
. - The group
example@googlegroups.com
would begroup-example@googlegroups.com
. - All members of the Google Apps for Business domain
example.com
would bedomain-example.com
. For project entities,project-{team}-{projectnumber}
format will be returned on response.
string entity = 3;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
clearEntityAlt()
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
clearEntityId()
public ObjectAccessControl.Builder clearEntityId()
The ID for the entity, if any.
string entity_id = 4;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
clearEtag()
public ObjectAccessControl.Builder clearEtag()
The etag of the ObjectAccessControl. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object's ObjectAccessControl.
string etag = 8;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ObjectAccessControl.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
clearId()
public ObjectAccessControl.Builder clearId()
The ID of the access-control entry.
string id = 2;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ObjectAccessControl.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
clearProjectTeam()
public ObjectAccessControl.Builder clearProjectTeam()
The project team associated with the entity, if any.
.google.storage.v2.ProjectTeam project_team = 7;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
clearRole()
public ObjectAccessControl.Builder clearRole()
The access permission for the entity. One of the following values:
READER
WRITER
OWNER
string role = 1;
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
clone()
public ObjectAccessControl.Builder clone()
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
getDefaultInstanceForType()
public ObjectAccessControl getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ObjectAccessControl |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 beuser-liz@example.com
. - The group
example@googlegroups.com
would begroup-example@googlegroups.com
. - All members of the Google Apps for Business domain
example.com
would bedomain-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 beuser-liz@example.com
. - The group
example@googlegroups.com
would begroup-example@googlegroups.com
. - All members of the Google Apps for Business domain
example.com
would bedomain-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 ObjectAccessControl. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object's ObjectAccessControl.
string etag = 8;
Returns | |
---|---|
Type | Description |
String |
The etag. |
getEtagBytes()
public ByteString getEtagBytes()
The etag of the ObjectAccessControl. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object's ObjectAccessControl.
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. One of the following values:
READER
WRITER
OWNER
string role = 1;
Returns | |
---|---|
Type | Description |
String |
The role. |
getRoleBytes()
public ByteString getRoleBytes()
The access permission for the entity. One of the following values:
READER
WRITER
OWNER
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 |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ObjectAccessControl.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ObjectAccessControl.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
mergeFrom(ObjectAccessControl other)
public ObjectAccessControl.Builder mergeFrom(ObjectAccessControl other)
Parameter | |
---|---|
Name | Description |
other |
ObjectAccessControl |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
mergeProjectTeam(ProjectTeam value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ObjectAccessControl.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
setDomain(String value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setDomainBytes(ByteString value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEmail(String value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEmailBytes(ByteString value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEntity(String value)
public ObjectAccessControl.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 beuser-liz@example.com
. - The group
example@googlegroups.com
would begroup-example@googlegroups.com
. - All members of the Google Apps for Business domain
example.com
would bedomain-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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEntityAlt(String value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEntityAltBytes(ByteString value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEntityBytes(ByteString value)
public ObjectAccessControl.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 beuser-liz@example.com
. - The group
example@googlegroups.com
would begroup-example@googlegroups.com
. - All members of the Google Apps for Business domain
example.com
would bedomain-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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEntityId(String value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEntityIdBytes(ByteString value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setEtag(String value)
public ObjectAccessControl.Builder setEtag(String value)
The etag of the ObjectAccessControl. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object's ObjectAccessControl.
string etag = 8;
Parameter | |
---|---|
Name | Description |
value |
String The etag to set. |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public ObjectAccessControl.Builder setEtagBytes(ByteString value)
The etag of the ObjectAccessControl. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object's ObjectAccessControl.
string etag = 8;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ObjectAccessControl.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
setId(String value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setIdBytes(ByteString value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
This builder for chaining. |
setProjectTeam(ProjectTeam value)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
setProjectTeam(ProjectTeam.Builder builderForValue)
public ObjectAccessControl.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 |
ObjectAccessControl.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ObjectAccessControl.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
setRole(String value)
public ObjectAccessControl.Builder setRole(String value)
The access permission for the entity. One of the following values:
READER
WRITER
OWNER
string role = 1;
Parameter | |
---|---|
Name | Description |
value |
String The role to set. |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
setRoleBytes(ByteString value)
public ObjectAccessControl.Builder setRoleBytes(ByteString value)
The access permission for the entity. One of the following values:
READER
WRITER
OWNER
string role = 1;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for role to set. |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ObjectAccessControl.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ObjectAccessControl.Builder |