google::cloud::storage::ObjectAccessControl Class Reference

Wraps the objectAccessControl resource in Google Cloud Storage. More...

#include <google/cloud/storage/object_access_control.h>

Public Member Functions
	ObjectAccessControl ()=default
Accessors.
std::string const &	bucket () const
std::string const &	object () const
std::int64_t	generation () const
std::string const &	domain () const
std::string const &	email () const
std::string const &	entity () const
std::string const &	entity_id () const
std::string const &	etag () const
std::string const &	id () const
std::string const &	kind () const
bool	has_project_team () const
ProjectTeam const &	project_team () const
absl::optional< ProjectTeam > const &	project_team_as_optional () const
std::string const &	role () const
std::string const &	self_link () const
Modifiers for mutable attributes.
ObjectAccessControl &	set_entity (std::string v)
ObjectAccessControl &	set_role (std::string v)
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.
ObjectAccessControl &	set_bucket (std::string v)
ObjectAccessControl &	set_object (std::string v)
ObjectAccessControl &	set_generation (std::int64_t v)
ObjectAccessControl &	set_domain (std::string v)
ObjectAccessControl &	set_email (std::string v)
ObjectAccessControl &	set_entity_id (std::string v)
ObjectAccessControl &	set_etag (std::string v)
ObjectAccessControl &	set_id (std::string v)
ObjectAccessControl &	set_kind (std::string v)
ObjectAccessControl &	set_project_team (ProjectTeam v)
ObjectAccessControl &	set_self_link (std::string v)

Static Public Member Functions
Well-known values for the role() field..
static std::string	ROLE_OWNER ()
static std::string	ROLE_READER ()
Well-known values for the project_team().team field..
static std::string	TEAM_EDITORS ()
static std::string	TEAM_OWNERS ()
static std::string	TEAM_VIEWERS ()

Friends
bool	operator== (ObjectAccessControl const &lhs, ObjectAccessControl const &rhs)
bool	operator!= (ObjectAccessControl const &lhs, ObjectAccessControl const &rhs)

Detailed Description

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.

Constructor & Destructor Documentation

ObjectAccessControl()

google::cloud::storage::ObjectAccessControl::ObjectAccessControl ( )

default

Member Function Documentation

bucket()

std::string const & google::cloud::storage::ObjectAccessControl::bucket ( ) const

inline

domain()

std::string const & google::cloud::storage::ObjectAccessControl::domain ( ) const

inline

email()

std::string const & google::cloud::storage::ObjectAccessControl::email ( ) const

inline

entity()

std::string const & google::cloud::storage::ObjectAccessControl::entity ( ) const

inline

entity_id()

std::string const & google::cloud::storage::ObjectAccessControl::entity_id ( ) const

inline

etag()

std::string const & google::cloud::storage::ObjectAccessControl::etag ( ) const

inline

generation()

std::int64_t google::cloud::storage::ObjectAccessControl::generation ( ) const

inline

has_project_team()

bool google::cloud::storage::ObjectAccessControl::has_project_team ( ) const

inline

id()

std::string const & google::cloud::storage::ObjectAccessControl::id ( ) const

inline

kind()

std::string const & google::cloud::storage::ObjectAccessControl::kind ( ) const

inline

object()

std::string const & google::cloud::storage::ObjectAccessControl::object ( ) const

inline

project_team()

ProjectTeam const & google::cloud::storage::ObjectAccessControl::project_team ( ) const

inline

project_team_as_optional()

absl::optional< ProjectTeam > const & google::cloud::storage::ObjectAccessControl::project_team_as_optional ( ) const

inline

role()

std::string const & google::cloud::storage::ObjectAccessControl::role ( ) const

inline

ROLE_OWNER()

static std::string google::cloud::storage::ObjectAccessControl::ROLE_OWNER ( )

inlinestatic

ROLE_READER()

static std::string google::cloud::storage::ObjectAccessControl::ROLE_READER ( )

inlinestatic

self_link()

std::string const & google::cloud::storage::ObjectAccessControl::self_link ( ) const

inline

set_bucket()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_bucket ( std::string  v )

inline

set_domain()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_domain ( std::string  v )

inline

set_email()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_email ( std::string  v )

inline

set_entity()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_entity ( std::string  v )

inline

set_entity_id()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_entity_id ( std::string  v )

inline

set_etag()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_etag ( std::string  v )

inline

set_generation()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_generation ( std::int64_t  v )

inline

set_id()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_id ( std::string  v )

inline

set_kind()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_kind ( std::string  v )

inline

set_object()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_object ( std::string  v )

inline

set_project_team()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_project_team ( ProjectTeam  v )

inline

set_role()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_role ( std::string  v )

inline

set_self_link()

ObjectAccessControl & google::cloud::storage::ObjectAccessControl::set_self_link ( std::string  v )

inline

TEAM_EDITORS()

static std::string google::cloud::storage::ObjectAccessControl::TEAM_EDITORS ( )

inlinestatic

TEAM_OWNERS()

static std::string google::cloud::storage::ObjectAccessControl::TEAM_OWNERS ( )

inlinestatic

TEAM_VIEWERS()

static std::string google::cloud::storage::ObjectAccessControl::TEAM_VIEWERS ( )

inlinestatic

Friends And Related Function Documentation

operator!=

bool operator!= ( ObjectAccessControl const &  lhs, ObjectAccessControl const &  rhs  )

friend

operator==

bool operator== ( ObjectAccessControl const &  lhs, ObjectAccessControl const &  rhs  )

friend