google_storage_api::Policy Class Reference

#include <policy.h>

Inheritance diagram for google_storage_api::Policy:

Classes
class	PolicyBindings

Public Member Functions
	Policy (const Json::Value &storage)
	Policy (Json::Value *storage)
virtual	~Policy ()
const StringPiece	GetTypeName () const
bool	has_bindings () const
void	clear_bindings ()
const client::JsonCppArray< PolicyBindings >	get_bindings () const
client::JsonCppArray< PolicyBindings >	mutable_bindings ()
bool	has_etag () const
void	clear_etag ()
const StringPiece	get_etag () const
void	set_etag (const StringPiece &value)
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_resource_id () const
void	clear_resource_id ()
const StringPiece	get_resource_id () const
void	set_resource_id (const StringPiece &value)
bool	has_version () const
void	clear_version ()
int32	get_version () const
void	set_version (int32 value)

Static Public Member Functions
static Policy *	New ()

Detailed Description

A bucket/object IAM policy.

Constructor & Destructor Documentation

Policy() [1/2]

google_storage_api::Policy::Policy ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Policy() [2/2]

google_storage_api::Policy::Policy ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Policy()

google_storage_api::Policy::~Policy ( )

virtual

Standard destructor.

Member Function Documentation

clear_bindings()

void google_storage_api::Policy::clear_bindings ( )

inline

Clears the 'bindings' attribute.

clear_etag()

void google_storage_api::Policy::clear_etag ( )

inline

Clears the 'etag' attribute.

clear_kind()

void google_storage_api::Policy::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_resource_id()

void google_storage_api::Policy::clear_resource_id ( )

inline

Clears the 'resourceId' attribute.

clear_version()

void google_storage_api::Policy::clear_version ( )

inline

Clears the 'version' attribute.

get_bindings()

const client::JsonCppArray<PolicyBindings > google_storage_api::Policy::get_bindings ( ) const

inline

Get a reference to the value of the 'bindings' attribute.

get_etag()

const StringPiece google_storage_api::Policy::get_etag ( ) const

inline

Get the value of the 'etag' attribute.

get_kind()

const StringPiece google_storage_api::Policy::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_resource_id()

const StringPiece google_storage_api::Policy::get_resource_id ( ) const

inline

Get the value of the 'resourceId' attribute.

get_version()

int32 google_storage_api::Policy::get_version ( ) const

inline

Get the value of the 'version' attribute.

GetTypeName()

const StringPiece google_storage_api::Policy::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_storage_api::Policy

has_bindings()

bool google_storage_api::Policy::has_bindings ( ) const

inline

Determine if the 'bindings' attribute was set.

Returns

true if the 'bindings' attribute was set.

has_etag()

bool google_storage_api::Policy::has_etag ( ) const

inline

Determine if the 'etag' attribute was set.

Returns

true if the 'etag' attribute was set.

has_kind()

bool google_storage_api::Policy::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_resource_id()

bool google_storage_api::Policy::has_resource_id ( ) const

inline

Determine if the 'resourceId' attribute was set.

Returns

true if the 'resourceId' attribute was set.

has_version()

bool google_storage_api::Policy::has_version ( ) const

inline

Determine if the 'version' attribute was set.

Returns

true if the 'version' attribute was set.

mutable_bindings()

client::JsonCppArray<PolicyBindings > google_storage_api::Policy::mutable_bindings ( )

inline

Gets a reference to a mutable value of the 'bindings' property.

An association between a role, which comes with a set of permissions, and members who may assume that role.

Returns

The result can be modified to change the attribute value.

New()

Policy * google_storage_api::Policy::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_etag()

void google_storage_api::Policy::set_etag ( const StringPiece &  value )

inline

Change the 'etag' attribute.

HTTP 1.1 Entity tag for the policy.

Parameters

[in]

value

The new value.

set_kind()

void google_storage_api::Policy::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

The kind of item this is. For policies, this is always storage::policy. This field is ignored on input.

Parameters

[in]

value

The new value.

set_resource_id()

void google_storage_api::Policy::set_resource_id ( const StringPiece &  value )

inline

Change the 'resourceId' attribute.

The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.

Parameters

[in]

value

The new value.

set_version()

void google_storage_api::Policy::set_version ( int32  value )

inline

Change the 'version' attribute.

The IAM policy format version.

Parameters

[in]

value

The new value.

---

The documentation for this class was generated from the following files:

• google/storage_api/policy.h
• google/storage_api/policy.cc