bigquery  v2
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::Dataset Class Reference

#include <dataset.h>

Inheritance diagram for google_bigquery_api::Dataset:

Classes

class  DatasetAccess
 

Public Member Functions

 Dataset (const Json::Value &storage)
 
 Dataset (Json::Value *storage)
 
virtual ~Dataset ()
 
const StringPiece GetTypeName () const
 
bool has_access () const
 
void clear_access ()
 
const client::JsonCppArray< DatasetAccessget_access () const
 
client::JsonCppArray< DatasetAccessmutable_access ()
 
bool has_creation_time () const
 
void clear_creation_time ()
 
int64 get_creation_time () const
 
void set_creation_time (int64 value)
 
bool has_dataset_reference () const
 
void clear_dataset_reference ()
 
const DatasetReference get_dataset_reference () const
 
DatasetReference mutable_datasetReference ()
 
bool has_default_encryption_configuration () const
 
void clear_default_encryption_configuration ()
 
const EncryptionConfiguration get_default_encryption_configuration () const
 
EncryptionConfiguration mutable_defaultEncryptionConfiguration ()
 
bool has_default_partition_expiration_ms () const
 
void clear_default_partition_expiration_ms ()
 
int64 get_default_partition_expiration_ms () const
 
void set_default_partition_expiration_ms (int64 value)
 
bool has_default_table_expiration_ms () const
 
void clear_default_table_expiration_ms ()
 
int64 get_default_table_expiration_ms () const
 
void set_default_table_expiration_ms (int64 value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_etag () const
 
void clear_etag ()
 
const StringPiece get_etag () const
 
void set_etag (const StringPiece &value)
 
bool has_friendly_name () const
 
void clear_friendly_name ()
 
const StringPiece get_friendly_name () const
 
void set_friendly_name (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_labels () const
 
void clear_labels ()
 
const client::JsonCppAssociativeArray< string > get_labels () const
 
client::JsonCppAssociativeArray< string > mutable_labels ()
 
bool has_last_modified_time () const
 
void clear_last_modified_time ()
 
int64 get_last_modified_time () const
 
void set_last_modified_time (int64 value)
 
bool has_location () const
 
void clear_location ()
 
const StringPiece get_location () const
 
void set_location (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)
 

Static Public Member Functions

static DatasetNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ Dataset() [1/2]

google_bigquery_api::Dataset::Dataset ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ Dataset() [2/2]

google_bigquery_api::Dataset::Dataset ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~Dataset()

google_bigquery_api::Dataset::~Dataset ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_access()

void google_bigquery_api::Dataset::clear_access ( )
inline

Clears the 'access' attribute.

◆ clear_creation_time()

void google_bigquery_api::Dataset::clear_creation_time ( )
inline

Clears the 'creationTime' attribute.

◆ clear_dataset_reference()

void google_bigquery_api::Dataset::clear_dataset_reference ( )
inline

Clears the 'datasetReference' attribute.

◆ clear_default_encryption_configuration()

void google_bigquery_api::Dataset::clear_default_encryption_configuration ( )
inline

Clears the 'defaultEncryptionConfiguration' attribute.

◆ clear_default_partition_expiration_ms()

void google_bigquery_api::Dataset::clear_default_partition_expiration_ms ( )
inline

Clears the 'defaultPartitionExpirationMs' attribute.

◆ clear_default_table_expiration_ms()

void google_bigquery_api::Dataset::clear_default_table_expiration_ms ( )
inline

Clears the 'defaultTableExpirationMs' attribute.

◆ clear_description()

void google_bigquery_api::Dataset::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_etag()

void google_bigquery_api::Dataset::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_friendly_name()

void google_bigquery_api::Dataset::clear_friendly_name ( )
inline

Clears the 'friendlyName' attribute.

◆ clear_id()

void google_bigquery_api::Dataset::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_bigquery_api::Dataset::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_labels()

void google_bigquery_api::Dataset::clear_labels ( )
inline

Clears the 'labels' attribute.

◆ clear_last_modified_time()

void google_bigquery_api::Dataset::clear_last_modified_time ( )
inline

Clears the 'lastModifiedTime' attribute.

◆ clear_location()

void google_bigquery_api::Dataset::clear_location ( )
inline

Clears the 'location' attribute.

◆ clear_self_link()

void google_bigquery_api::Dataset::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ get_access()

const client::JsonCppArray<DatasetAccess > google_bigquery_api::Dataset::get_access ( ) const
inline

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

◆ get_creation_time()

int64 google_bigquery_api::Dataset::get_creation_time ( ) const
inline

Get the value of the 'creationTime' attribute.

◆ get_dataset_reference()

const DatasetReference google_bigquery_api::Dataset::get_dataset_reference ( ) const

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

◆ get_default_encryption_configuration()

const EncryptionConfiguration google_bigquery_api::Dataset::get_default_encryption_configuration ( ) const

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

◆ get_default_partition_expiration_ms()

int64 google_bigquery_api::Dataset::get_default_partition_expiration_ms ( ) const
inline

Get the value of the 'defaultPartitionExpirationMs' attribute.

◆ get_default_table_expiration_ms()

int64 google_bigquery_api::Dataset::get_default_table_expiration_ms ( ) const
inline

Get the value of the 'defaultTableExpirationMs' attribute.

◆ get_description()

const StringPiece google_bigquery_api::Dataset::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_etag()

const StringPiece google_bigquery_api::Dataset::get_etag ( ) const
inline

Get the value of the 'etag' attribute.

◆ get_friendly_name()

const StringPiece google_bigquery_api::Dataset::get_friendly_name ( ) const
inline

Get the value of the 'friendlyName' attribute.

◆ get_id()

const StringPiece google_bigquery_api::Dataset::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_bigquery_api::Dataset::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_labels()

const client::JsonCppAssociativeArray<string > google_bigquery_api::Dataset::get_labels ( ) const
inline

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

◆ get_last_modified_time()

int64 google_bigquery_api::Dataset::get_last_modified_time ( ) const
inline

Get the value of the 'lastModifiedTime' attribute.

◆ get_location()

const StringPiece google_bigquery_api::Dataset::get_location ( ) const
inline

Get the value of the 'location' attribute.

◆ get_self_link()

const StringPiece google_bigquery_api::Dataset::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::Dataset::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::Dataset

◆ has_access()

bool google_bigquery_api::Dataset::has_access ( ) const
inline

Determine if the 'access' attribute was set.

Returns
true if the 'access' attribute was set.

◆ has_creation_time()

bool google_bigquery_api::Dataset::has_creation_time ( ) const
inline

Determine if the 'creationTime' attribute was set.

Returns
true if the 'creationTime' attribute was set.

◆ has_dataset_reference()

bool google_bigquery_api::Dataset::has_dataset_reference ( ) const
inline

Determine if the 'datasetReference' attribute was set.

Returns
true if the 'datasetReference' attribute was set.

◆ has_default_encryption_configuration()

bool google_bigquery_api::Dataset::has_default_encryption_configuration ( ) const
inline

Determine if the 'defaultEncryptionConfiguration' attribute was set.

Returns
true if the 'defaultEncryptionConfiguration' attribute was set.

◆ has_default_partition_expiration_ms()

bool google_bigquery_api::Dataset::has_default_partition_expiration_ms ( ) const
inline

Determine if the 'defaultPartitionExpirationMs' attribute was set.

Returns
true if the 'defaultPartitionExpirationMs' attribute was set.

◆ has_default_table_expiration_ms()

bool google_bigquery_api::Dataset::has_default_table_expiration_ms ( ) const
inline

Determine if the 'defaultTableExpirationMs' attribute was set.

Returns
true if the 'defaultTableExpirationMs' attribute was set.

◆ has_description()

bool google_bigquery_api::Dataset::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_etag()

bool google_bigquery_api::Dataset::has_etag ( ) const
inline

Determine if the 'etag' attribute was set.

Returns
true if the 'etag' attribute was set.

◆ has_friendly_name()

bool google_bigquery_api::Dataset::has_friendly_name ( ) const
inline

Determine if the 'friendlyName' attribute was set.

Returns
true if the 'friendlyName' attribute was set.

◆ has_id()

bool google_bigquery_api::Dataset::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_bigquery_api::Dataset::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_labels()

bool google_bigquery_api::Dataset::has_labels ( ) const
inline

Determine if the 'labels' attribute was set.

Returns
true if the 'labels' attribute was set.

◆ has_last_modified_time()

bool google_bigquery_api::Dataset::has_last_modified_time ( ) const
inline

Determine if the 'lastModifiedTime' attribute was set.

Returns
true if the 'lastModifiedTime' attribute was set.

◆ has_location()

bool google_bigquery_api::Dataset::has_location ( ) const
inline

Determine if the 'location' attribute was set.

Returns
true if the 'location' attribute was set.

◆ has_self_link()

bool google_bigquery_api::Dataset::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ mutable_access()

client::JsonCppArray<DatasetAccess > google_bigquery_api::Dataset::mutable_access ( )
inline

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

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;.

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

◆ mutable_datasetReference()

DatasetReference google_bigquery_api::Dataset::mutable_datasetReference ( )

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

[Required] A reference that identifies the dataset.

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

◆ mutable_defaultEncryptionConfiguration()

EncryptionConfiguration google_bigquery_api::Dataset::mutable_defaultEncryptionConfiguration ( )

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

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

◆ mutable_labels()

client::JsonCppAssociativeArray<string > google_bigquery_api::Dataset::mutable_labels ( )
inline

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

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.

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

◆ New()

Dataset * google_bigquery_api::Dataset::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_creation_time()

void google_bigquery_api::Dataset::set_creation_time ( int64  value)
inline

Change the 'creationTime' attribute.

[Output-only] The time when this dataset was created, in milliseconds since the epoch.

Parameters
[in]valueThe new value.

◆ set_default_partition_expiration_ms()

void google_bigquery_api::Dataset::set_default_partition_expiration_ms ( int64  value)
inline

Change the 'defaultPartitionExpirationMs' attribute.

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.

Parameters
[in]valueThe new value.

◆ set_default_table_expiration_ms()

void google_bigquery_api::Dataset::set_default_table_expiration_ms ( int64  value)
inline

Change the 'defaultTableExpirationMs' attribute.

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.

Parameters
[in]valueThe new value.

◆ set_description()

void google_bigquery_api::Dataset::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

[Optional] A user-friendly description of the dataset.

Parameters
[in]valueThe new value.

◆ set_etag()

void google_bigquery_api::Dataset::set_etag ( const StringPiece &  value)
inline

Change the 'etag' attribute.

[Output-only] A hash of the resource.

Parameters
[in]valueThe new value.

◆ set_friendly_name()

void google_bigquery_api::Dataset::set_friendly_name ( const StringPiece &  value)
inline

Change the 'friendlyName' attribute.

[Optional] A descriptive name for the dataset.

Parameters
[in]valueThe new value.

◆ set_id()

void google_bigquery_api::Dataset::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_bigquery_api::Dataset::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

[Output-only] The resource type.

Parameters
[in]valueThe new value.

◆ set_last_modified_time()

void google_bigquery_api::Dataset::set_last_modified_time ( int64  value)
inline

Change the 'lastModifiedTime' attribute.

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Parameters
[in]valueThe new value.

◆ set_location()

void google_bigquery_api::Dataset::set_location ( const StringPiece &  value)
inline

Change the 'location' attribute.

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_bigquery_api::Dataset::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

Parameters
[in]valueThe new value.

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