Class ObjectAccessControl (2.16.0)
Version 2.16.0keyboard_arrow_down
public final class ObjectAccessControl extends GeneratedMessageV3 implements ObjectAccessControlOrBuilder
An access-control entry.
Protobuf type google.storage.v2.ObjectAccessControl
Static Fields
DOMAIN_FIELD_NUMBER
public static final int DOMAIN_FIELD_NUMBER
Field Value
EMAIL_FIELD_NUMBER
public static final int EMAIL_FIELD_NUMBER
Field Value
ENTITY_ALT_FIELD_NUMBER
public static final int ENTITY_ALT_FIELD_NUMBER
Field Value
ENTITY_FIELD_NUMBER
public static final int ENTITY_FIELD_NUMBER
Field Value
ENTITY_ID_FIELD_NUMBER
public static final int ENTITY_ID_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
PROJECT_TEAM_FIELD_NUMBER
public static final int PROJECT_TEAM_FIELD_NUMBER
Field Value
ROLE_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ObjectAccessControl getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static ObjectAccessControl . Builder newBuilder ()
Returns
newBuilder(ObjectAccessControl prototype)
public static ObjectAccessControl . Builder newBuilder ( ObjectAccessControl prototype )
Parameter
Returns
public static ObjectAccessControl parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ObjectAccessControl parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ObjectAccessControl parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ObjectAccessControl parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ObjectAccessControl parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ObjectAccessControl parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ObjectAccessControl parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ObjectAccessControl parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ObjectAccessControl parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ObjectAccessControl parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ObjectAccessControl parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ObjectAccessControl parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<ObjectAccessControl> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ObjectAccessControl getDefaultInstanceForType ()
Returns
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
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
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}allUsersallAuthenticatedUsers
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}allUsersallAuthenticatedUsers
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
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()
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
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
getParserForType()
public Parser<ObjectAccessControl> getParserForType ()
Returns
Overrides
getProjectTeam()
public ProjectTeam getProjectTeam ()
The project team associated with the entity, if any.
.google.storage.v2.ProjectTeam project_team = 7;
Returns
getProjectTeamOrBuilder()
public ProjectTeamOrBuilder getProjectTeamOrBuilder ()
The project team associated with the entity, if any.
.google.storage.v2.ProjectTeam project_team = 7;
Returns
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
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public ObjectAccessControl . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ObjectAccessControl . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public ObjectAccessControl . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
