Class ObjectAccessControl (2.16.0) 

public final class ObjectAccessControl extends GeneratedMessageV3 implements ObjectAccessControlOrBuilder

An access-control entry.

Protobuf type google.storage.v2.ObjectAccessControl

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ObjectAccessControl

Static Fields

DOMAIN_FIELD_NUMBER

public static final int DOMAIN_FIELD_NUMBER
Field Value
Type Description
int

EMAIL_FIELD_NUMBER

public static final int EMAIL_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_ALT_FIELD_NUMBER

public static final int ENTITY_ALT_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_FIELD_NUMBER

public static final int ENTITY_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_ID_FIELD_NUMBER

public static final int ENTITY_ID_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_TEAM_FIELD_NUMBER

public static final int PROJECT_TEAM_FIELD_NUMBER
Field Value
Type Description
int

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ObjectAccessControl getDefaultInstance()
Returns
Type Description
ObjectAccessControl

getDescriptor()

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

newBuilder()

public static ObjectAccessControl.Builder newBuilder()
Returns
Type Description
ObjectAccessControl.Builder

newBuilder(ObjectAccessControl prototype)

public static ObjectAccessControl.Builder newBuilder(ObjectAccessControl prototype)
Parameter
Name Description
prototype ObjectAccessControl
Returns
Type Description
ObjectAccessControl.Builder

parseDelimitedFrom(InputStream input)

public static ObjectAccessControl parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ObjectAccessControl parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ObjectAccessControl parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ObjectAccessControl parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ObjectAccessControl parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ObjectAccessControl parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ObjectAccessControl parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ObjectAccessControl parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ObjectAccessControl parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ObjectAccessControl parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ObjectAccessControl parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ObjectAccessControl parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ObjectAccessControl
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ObjectAccessControl> parser()
Returns
Type Description
Parser<ObjectAccessControl>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ObjectAccessControl getDefaultInstanceForType()
Returns
Type Description
ObjectAccessControl

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 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.

getParserForType()

public Parser<ObjectAccessControl> getParserForType()
Returns
Type Description
Parser<ObjectAccessControl>
Overrides

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.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ObjectAccessControl.Builder newBuilderForType()
Returns
Type Description
ObjectAccessControl.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ObjectAccessControl.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ObjectAccessControl.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ObjectAccessControl.Builder toBuilder()
Returns
Type Description
ObjectAccessControl.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException