#include <notification.h>

Inheritance diagram for google_storage_api::Notification:

Public Member Functions
	Notification (const Json::Value &storage)

	Notification (Json::Value *storage)

virtual	~Notification ()

const StringPiece	GetTypeName () const

bool	has_custom_attributes () const

void	clear_custom_attributes ()

const client::JsonCppAssociativeArray< string >	get_custom_attributes () const

client::JsonCppAssociativeArray< string >	mutable_custom_attributes ()

bool	has_etag () const

void	clear_etag ()

const StringPiece	get_etag () const

void	set_etag (const StringPiece &value)

bool	has_event_types () const

void	clear_event_types ()

const client::JsonCppArray< string >	get_event_types () const

client::JsonCppArray< string >	mutable_event_types ()

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_object_name_prefix () const

void	clear_object_name_prefix ()

const StringPiece	get_object_name_prefix () const

void	set_object_name_prefix (const StringPiece &value)

bool	has_payload_format () const

void	clear_payload_format ()

const StringPiece	get_payload_format () const

void	set_payload_format (const StringPiece &value)

bool	has_self_link () const

void	clear_self_link ()

const StringPiece	get_self_link () const

void	set_self_link (const StringPiece &value)

bool	has_topic () const

void	clear_topic ()

const StringPiece	get_topic () const

void	set_topic (const StringPiece &value)

Static Public Member Functions
static Notification *	New ()

Detailed Description

A subscription to receive Google PubSub notifications.

Constructor & Destructor Documentation

◆ Notification() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Notification() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Notification()

google_storage_api::Notification::~Notification ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_custom_attributes()

void google_storage_api::Notification::clear_custom_attributes ( )

inline

Clears the 'custom_attributes' attribute.

◆ clear_etag()

void google_storage_api::Notification::clear_etag ( )

inline

Clears the 'etag' attribute.

◆ clear_event_types()

void google_storage_api::Notification::clear_event_types ( )

inline

Clears the 'event_types' attribute.

◆ clear_id()

void google_storage_api::Notification::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_storage_api::Notification::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_object_name_prefix()

void google_storage_api::Notification::clear_object_name_prefix ( )

inline

Clears the 'object_name_prefix' attribute.

◆ clear_payload_format()

void google_storage_api::Notification::clear_payload_format ( )

inline

Clears the 'payload_format' attribute.

◆ clear_self_link()

void google_storage_api::Notification::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

◆ clear_topic()

void google_storage_api::Notification::clear_topic ( )

inline

Clears the 'topic' attribute.

◆ get_custom_attributes()

const client::JsonCppAssociativeArray<string > google_storage_api::Notification::get_custom_attributes ( ) const

inline

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

◆ get_etag()

const StringPiece google_storage_api::Notification::get_etag ( ) const

inline

Get the value of the 'etag' attribute.

◆ get_event_types()

const client::JsonCppArray<string > google_storage_api::Notification::get_event_types ( ) const

inline

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

◆ get_id()

const StringPiece google_storage_api::Notification::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_storage_api::Notification::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_object_name_prefix()

const StringPiece google_storage_api::Notification::get_object_name_prefix ( ) const

inline

Get the value of the 'object_name_prefix' attribute.

◆ get_payload_format()

const StringPiece google_storage_api::Notification::get_payload_format ( ) const

inline

Get the value of the 'payload_format' attribute.

◆ get_self_link()

const StringPiece google_storage_api::Notification::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

◆ get_topic()

const StringPiece google_storage_api::Notification::get_topic ( ) const

inline

Get the value of the 'topic' attribute.

◆ GetTypeName()

const StringPiece google_storage_api::Notification::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_storage_api::Notification

◆ has_custom_attributes()

bool google_storage_api::Notification::has_custom_attributes ( ) const

inline

Determine if the 'custom_attributes' attribute was set.

Returns: true if the 'custom_attributes' attribute was set.

◆ has_etag()

bool google_storage_api::Notification::has_etag ( ) const

inline

Determine if the 'etag' attribute was set.

Returns: true if the 'etag' attribute was set.

◆ has_event_types()

bool google_storage_api::Notification::has_event_types ( ) const

inline

Determine if the 'event_types' attribute was set.

Returns: true if the 'event_types' attribute was set.

◆ has_id()

bool google_storage_api::Notification::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_kind()

bool google_storage_api::Notification::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_object_name_prefix()

bool google_storage_api::Notification::has_object_name_prefix ( ) const

inline

Determine if the 'object_name_prefix' attribute was set.

Returns: true if the 'object_name_prefix' attribute was set.

◆ has_payload_format()

bool google_storage_api::Notification::has_payload_format ( ) const

inline

Determine if the 'payload_format' attribute was set.

Returns: true if the 'payload_format' attribute was set.

◆ has_self_link()

bool google_storage_api::Notification::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

Returns: true if the 'selfLink' attribute was set.

◆ has_topic()

bool google_storage_api::Notification::has_topic ( ) const

inline

Determine if the 'topic' attribute was set.

Returns: true if the 'topic' attribute was set.

◆ mutable_custom_attributes()

client::JsonCppAssociativeArray<string > google_storage_api::Notification::mutable_custom_attributes ( )

inline

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

An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.

Returns: The result can be modified to change the attribute value.

◆ mutable_event_types()

client::JsonCppArray<string > google_storage_api::Notification::mutable_event_types ( )

inline

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

If present, only send notifications about listed event types. If empty, sent notifications for all event types.

Returns: The result can be modified to change the attribute value.

◆ New()

Notification * google_storage_api::Notification::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_etag()

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

inline

Change the 'etag' attribute.

HTTP 1.1 Entity tag for this subscription notification.

Parameters

[in] value The new value.

◆ set_id()

void google_storage_api::Notification::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

The ID of the notification.

Parameters

[in] value The new value.

◆ set_kind()

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

inline

Change the 'kind' attribute.

The kind of item this is. For notifications, this is always storage::notification.

Parameters

[in] value The new value.

◆ set_object_name_prefix()

void google_storage_api::Notification::set_object_name_prefix ( const StringPiece & value )

inline

Change the 'object_name_prefix' attribute.

If present, only apply this notification configuration to object names that begin with this prefix.

Parameters

[in] value The new value.

◆ set_payload_format()

void google_storage_api::Notification::set_payload_format ( const StringPiece & value )

inline

Change the 'payload_format' attribute.

The desired content of the Payload.

Parameters

[in] value The new value.

◆ set_self_link()

void google_storage_api::Notification::set_self_link ( const StringPiece & value )

inline

Change the 'selfLink' attribute.

The canonical URL of this notification.

Parameters

[in] value The new value.

◆ set_topic()

void google_storage_api::Notification::set_topic ( const StringPiece & value )

inline

Change the 'topic' attribute.

The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'.

Parameters

[in] value The new value.

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

google/storage_api/notification.h
google/storage_api/notification.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Notification() [1/2]

◆ Notification() [2/2]

◆ ~Notification()

Member Function Documentation

◆ clear_custom_attributes()

◆ clear_etag()

◆ clear_event_types()

◆ clear_id()

◆ clear_kind()

◆ clear_object_name_prefix()

◆ clear_payload_format()

◆ clear_self_link()

◆ clear_topic()

◆ get_custom_attributes()

◆ get_etag()

◆ get_event_types()

◆ get_id()

◆ get_kind()

◆ get_object_name_prefix()

◆ get_payload_format()

◆ get_self_link()

◆ get_topic()

◆ GetTypeName()

◆ has_custom_attributes()

◆ has_etag()

◆ has_event_types()

◆ has_id()

◆ has_kind()

◆ has_object_name_prefix()

◆ has_payload_format()

◆ has_self_link()

◆ has_topic()

◆ mutable_custom_attributes()

◆ mutable_event_types()

◆ New()

◆ set_etag()

◆ set_id()

◆ set_kind()

◆ set_object_name_prefix()

◆ set_payload_format()

◆ set_self_link()

◆ set_topic()