analytics  v3
Public Member Functions | Static Public Member Functions | List of all members
google_analytics_api::Segment Class Reference

#include <segment.h>

Inheritance diagram for google_analytics_api::Segment:

Public Member Functions

 Segment (const Json::Value &storage)
 
 Segment (Json::Value *storage)
 
virtual ~Segment ()
 
const StringPiece GetTypeName () const
 
bool has_created () const
 
void clear_created ()
 
client::DateTime get_created () const
 
void set_created (client::DateTime value)
 
bool has_definition () const
 
void clear_definition ()
 
const StringPiece get_definition () const
 
void set_definition (const StringPiece &value)
 
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_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_segment_id () const
 
void clear_segment_id ()
 
const StringPiece get_segment_id () const
 
void set_segment_id (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_type () const
 
void clear_type ()
 
const StringPiece get_type () const
 
void set_type (const StringPiece &value)
 
bool has_updated () const
 
void clear_updated ()
 
client::DateTime get_updated () const
 
void set_updated (client::DateTime value)
 

Static Public Member Functions

static SegmentNew ()
 

Detailed Description

JSON template for an Analytics segment.

Constructor & Destructor Documentation

◆ Segment() [1/2]

google_analytics_api::Segment::Segment ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ Segment() [2/2]

google_analytics_api::Segment::Segment ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~Segment()

google_analytics_api::Segment::~Segment ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_created()

void google_analytics_api::Segment::clear_created ( )
inline

Clears the 'created' attribute.

◆ clear_definition()

void google_analytics_api::Segment::clear_definition ( )
inline

Clears the 'definition' attribute.

◆ clear_id()

void google_analytics_api::Segment::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_analytics_api::Segment::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_analytics_api::Segment::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_segment_id()

void google_analytics_api::Segment::clear_segment_id ( )
inline

Clears the 'segmentId' attribute.

◆ clear_self_link()

void google_analytics_api::Segment::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_type()

void google_analytics_api::Segment::clear_type ( )
inline

Clears the 'type' attribute.

◆ clear_updated()

void google_analytics_api::Segment::clear_updated ( )
inline

Clears the 'updated' attribute.

◆ get_created()

client::DateTime google_analytics_api::Segment::get_created ( ) const
inline

Get the value of the 'created' attribute.

◆ get_definition()

const StringPiece google_analytics_api::Segment::get_definition ( ) const
inline

Get the value of the 'definition' attribute.

◆ get_id()

const StringPiece google_analytics_api::Segment::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_analytics_api::Segment::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_analytics_api::Segment::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_segment_id()

const StringPiece google_analytics_api::Segment::get_segment_id ( ) const
inline

Get the value of the 'segmentId' attribute.

◆ get_self_link()

const StringPiece google_analytics_api::Segment::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_type()

const StringPiece google_analytics_api::Segment::get_type ( ) const
inline

Get the value of the 'type' attribute.

◆ get_updated()

client::DateTime google_analytics_api::Segment::get_updated ( ) const
inline

Get the value of the 'updated' attribute.

◆ GetTypeName()

const StringPiece google_analytics_api::Segment::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_analytics_api::Segment

◆ has_created()

bool google_analytics_api::Segment::has_created ( ) const
inline

Determine if the 'created' attribute was set.

Returns
true if the 'created' attribute was set.

◆ has_definition()

bool google_analytics_api::Segment::has_definition ( ) const
inline

Determine if the 'definition' attribute was set.

Returns
true if the 'definition' attribute was set.

◆ has_id()

bool google_analytics_api::Segment::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_analytics_api::Segment::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_name()

bool google_analytics_api::Segment::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_segment_id()

bool google_analytics_api::Segment::has_segment_id ( ) const
inline

Determine if the 'segmentId' attribute was set.

Returns
true if the 'segmentId' attribute was set.

◆ has_self_link()

bool google_analytics_api::Segment::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_type()

bool google_analytics_api::Segment::has_type ( ) const
inline

Determine if the 'type' attribute was set.

Returns
true if the 'type' attribute was set.

◆ has_updated()

bool google_analytics_api::Segment::has_updated ( ) const
inline

Determine if the 'updated' attribute was set.

Returns
true if the 'updated' attribute was set.

◆ New()

Segment * google_analytics_api::Segment::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_created()

void google_analytics_api::Segment::set_created ( client::DateTime  value)
inline

Change the 'created' attribute.

Time the segment was created.

Parameters
[in]valueThe new value.

◆ set_definition()

void google_analytics_api::Segment::set_definition ( const StringPiece &  value)
inline

Change the 'definition' attribute.

Segment definition.

Parameters
[in]valueThe new value.

◆ set_id()

void google_analytics_api::Segment::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

Segment ID.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_analytics_api::Segment::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Resource type for Analytics segment.

Parameters
[in]valueThe new value.

◆ set_name()

void google_analytics_api::Segment::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

Segment name.

Parameters
[in]valueThe new value.

◆ set_segment_id()

void google_analytics_api::Segment::set_segment_id ( const StringPiece &  value)
inline

Change the 'segmentId' attribute.

Segment ID. Can be used with the 'segment' parameter in Core Reporting API.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_analytics_api::Segment::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

Link for this segment.

Parameters
[in]valueThe new value.

◆ set_type()

void google_analytics_api::Segment::set_type ( const StringPiece &  value)
inline

Change the 'type' attribute.

Type for a segment. Possible values are "BUILT_IN" or "CUSTOM".

Parameters
[in]valueThe new value.

◆ set_updated()

void google_analytics_api::Segment::set_updated ( client::DateTime  value)
inline

Change the 'updated' attribute.

Time the segment was last modified.

Parameters
[in]valueThe new value.

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