Class ObjectAccessControl (2.19.0)

Wraps the objectAccessControl resource in Google Cloud Storage.

objectAccessControl describes the access to a bucket for a single entity, where the entity might be a user, group, or other role.

See Also

https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls for an authoritative source of field definitions.

Constructors

ObjectAccessControl()

Functions

bucket() const

Accessors.

Returns
TypeDescription
std::string const &

object() const

Accessors.

Returns
TypeDescription
std::string const &

generation() const

Accessors.

Returns
TypeDescription
std::int64_t

domain() const

Accessors.

Returns
TypeDescription
std::string const &

email() const

Accessors.

Returns
TypeDescription
std::string const &

entity() const

Accessors.

Returns
TypeDescription
std::string const &

entity_id() const

Accessors.

Returns
TypeDescription
std::string const &

etag() const

Accessors.

Returns
TypeDescription
std::string const &

id() const

Accessors.

Returns
TypeDescription
std::string const &

kind() const

Accessors.

Returns
TypeDescription
std::string const &

has_project_team() const

Accessors.

Returns
TypeDescription
bool

project_team() const

Accessors.

Returns
TypeDescription
ProjectTeam const &

project_team_as_optional() const

Accessors.

Returns
TypeDescription
absl::optional< ProjectTeam > const &

role() const

Accessors.

Returns
TypeDescription
std::string const &

self_link() const

Accessors.

Returns
TypeDescription
std::string const &

set_entity(std::string)

Modifiers for mutable attributes.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_role(std::string)

Modifiers for mutable attributes.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_bucket(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_object(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_generation(std::int64_t)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::int64_t
Returns
TypeDescription
ObjectAccessControl &

set_domain(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_email(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_entity_id(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_etag(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_id(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_kind(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

set_project_team(ProjectTeam)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v ProjectTeam
Returns
TypeDescription
ObjectAccessControl &

set_self_link(std::string)

Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an ObjectAccessControl resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

Parameter
NameDescription
v std::string
Returns
TypeDescription
ObjectAccessControl &

static ROLE_OWNER()

Well-known values for the role() field..

Returns
TypeDescription
std::string

static ROLE_READER()

Well-known values for the role() field..

Returns
TypeDescription
std::string

static TEAM_EDITORS()

Well-known values for the project_team().team field..

Returns
TypeDescription
std::string

static TEAM_OWNERS()

Well-known values for the project_team().team field..

Returns
TypeDescription
std::string

static TEAM_VIEWERS()

Well-known values for the project_team().team field..

Returns
TypeDescription
std::string