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

#include <job_configuration_extract.h>

Inheritance diagram for google_bigquery_api::JobConfigurationExtract:

Public Member Functions

 JobConfigurationExtract (const Json::Value &storage)
 
 JobConfigurationExtract (Json::Value *storage)
 
virtual ~JobConfigurationExtract ()
 
const StringPiece GetTypeName () const
 
bool has_compression () const
 
void clear_compression ()
 
const StringPiece get_compression () const
 
void set_compression (const StringPiece &value)
 
bool has_destination_format () const
 
void clear_destination_format ()
 
const StringPiece get_destination_format () const
 
void set_destination_format (const StringPiece &value)
 
bool has_destination_uri () const
 
void clear_destination_uri ()
 
const StringPiece get_destination_uri () const
 
void set_destination_uri (const StringPiece &value)
 
bool has_destination_uris () const
 
void clear_destination_uris ()
 
const client::JsonCppArray< string > get_destination_uris () const
 
client::JsonCppArray< string > mutable_destinationUris ()
 
bool has_field_delimiter () const
 
void clear_field_delimiter ()
 
const StringPiece get_field_delimiter () const
 
void set_field_delimiter (const StringPiece &value)
 
bool has_print_header () const
 
void clear_print_header ()
 
bool get_print_header () const
 
void set_print_header (bool value)
 
bool has_source_model () const
 
void clear_source_model ()
 
const ModelReference get_source_model () const
 
ModelReference mutable_sourceModel ()
 
bool has_source_table () const
 
void clear_source_table ()
 
const TableReference get_source_table () const
 
TableReference mutable_sourceTable ()
 
bool has_use_avro_logical_types () const
 
void clear_use_avro_logical_types ()
 
bool get_use_avro_logical_types () const
 
void set_use_avro_logical_types (bool value)
 

Static Public Member Functions

static JobConfigurationExtractNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ JobConfigurationExtract() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ JobConfigurationExtract() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~JobConfigurationExtract()

google_bigquery_api::JobConfigurationExtract::~JobConfigurationExtract ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_compression()

void google_bigquery_api::JobConfigurationExtract::clear_compression ( )
inline

Clears the 'compression' attribute.

◆ clear_destination_format()

void google_bigquery_api::JobConfigurationExtract::clear_destination_format ( )
inline

Clears the 'destinationFormat' attribute.

◆ clear_destination_uri()

void google_bigquery_api::JobConfigurationExtract::clear_destination_uri ( )
inline

Clears the 'destinationUri' attribute.

◆ clear_destination_uris()

void google_bigquery_api::JobConfigurationExtract::clear_destination_uris ( )
inline

Clears the 'destinationUris' attribute.

◆ clear_field_delimiter()

void google_bigquery_api::JobConfigurationExtract::clear_field_delimiter ( )
inline

Clears the 'fieldDelimiter' attribute.

◆ clear_print_header()

void google_bigquery_api::JobConfigurationExtract::clear_print_header ( )
inline

Clears the 'printHeader' attribute.

◆ clear_source_model()

void google_bigquery_api::JobConfigurationExtract::clear_source_model ( )
inline

Clears the 'sourceModel' attribute.

◆ clear_source_table()

void google_bigquery_api::JobConfigurationExtract::clear_source_table ( )
inline

Clears the 'sourceTable' attribute.

◆ clear_use_avro_logical_types()

void google_bigquery_api::JobConfigurationExtract::clear_use_avro_logical_types ( )
inline

Clears the 'useAvroLogicalTypes' attribute.

◆ get_compression()

const StringPiece google_bigquery_api::JobConfigurationExtract::get_compression ( ) const
inline

Get the value of the 'compression' attribute.

◆ get_destination_format()

const StringPiece google_bigquery_api::JobConfigurationExtract::get_destination_format ( ) const
inline

Get the value of the 'destinationFormat' attribute.

◆ get_destination_uri()

const StringPiece google_bigquery_api::JobConfigurationExtract::get_destination_uri ( ) const
inline

Get the value of the 'destinationUri' attribute.

◆ get_destination_uris()

const client::JsonCppArray<string > google_bigquery_api::JobConfigurationExtract::get_destination_uris ( ) const
inline

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

◆ get_field_delimiter()

const StringPiece google_bigquery_api::JobConfigurationExtract::get_field_delimiter ( ) const
inline

Get the value of the 'fieldDelimiter' attribute.

◆ get_print_header()

bool google_bigquery_api::JobConfigurationExtract::get_print_header ( ) const
inline

Get the value of the 'printHeader' attribute.

◆ get_source_model()

const ModelReference google_bigquery_api::JobConfigurationExtract::get_source_model ( ) const

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

◆ get_source_table()

const TableReference google_bigquery_api::JobConfigurationExtract::get_source_table ( ) const

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

◆ get_use_avro_logical_types()

bool google_bigquery_api::JobConfigurationExtract::get_use_avro_logical_types ( ) const
inline

Get the value of the 'useAvroLogicalTypes' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::JobConfigurationExtract

◆ has_compression()

bool google_bigquery_api::JobConfigurationExtract::has_compression ( ) const
inline

Determine if the 'compression' attribute was set.

Returns
true if the 'compression' attribute was set.

◆ has_destination_format()

bool google_bigquery_api::JobConfigurationExtract::has_destination_format ( ) const
inline

Determine if the 'destinationFormat' attribute was set.

Returns
true if the 'destinationFormat' attribute was set.

◆ has_destination_uri()

bool google_bigquery_api::JobConfigurationExtract::has_destination_uri ( ) const
inline

Determine if the 'destinationUri' attribute was set.

Returns
true if the 'destinationUri' attribute was set.

◆ has_destination_uris()

bool google_bigquery_api::JobConfigurationExtract::has_destination_uris ( ) const
inline

Determine if the 'destinationUris' attribute was set.

Returns
true if the 'destinationUris' attribute was set.

◆ has_field_delimiter()

bool google_bigquery_api::JobConfigurationExtract::has_field_delimiter ( ) const
inline

Determine if the 'fieldDelimiter' attribute was set.

Returns
true if the 'fieldDelimiter' attribute was set.

◆ has_print_header()

bool google_bigquery_api::JobConfigurationExtract::has_print_header ( ) const
inline

Determine if the 'printHeader' attribute was set.

Returns
true if the 'printHeader' attribute was set.

◆ has_source_model()

bool google_bigquery_api::JobConfigurationExtract::has_source_model ( ) const
inline

Determine if the 'sourceModel' attribute was set.

Returns
true if the 'sourceModel' attribute was set.

◆ has_source_table()

bool google_bigquery_api::JobConfigurationExtract::has_source_table ( ) const
inline

Determine if the 'sourceTable' attribute was set.

Returns
true if the 'sourceTable' attribute was set.

◆ has_use_avro_logical_types()

bool google_bigquery_api::JobConfigurationExtract::has_use_avro_logical_types ( ) const
inline

Determine if the 'useAvroLogicalTypes' attribute was set.

Returns
true if the 'useAvroLogicalTypes' attribute was set.

◆ mutable_destinationUris()

client::JsonCppArray<string > google_bigquery_api::JobConfigurationExtract::mutable_destinationUris ( )
inline

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

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

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

◆ mutable_sourceModel()

ModelReference google_bigquery_api::JobConfigurationExtract::mutable_sourceModel ( )

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

A reference to the model being exported.

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

◆ mutable_sourceTable()

TableReference google_bigquery_api::JobConfigurationExtract::mutable_sourceTable ( )

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

A reference to the table being exported.

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

◆ New()

JobConfigurationExtract * google_bigquery_api::JobConfigurationExtract::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_compression()

void google_bigquery_api::JobConfigurationExtract::set_compression ( const StringPiece &  value)
inline

Change the 'compression' attribute.

[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro.

Parameters
[in]valueThe new value.

◆ set_destination_format()

void google_bigquery_api::JobConfigurationExtract::set_destination_format ( const StringPiece &  value)
inline

Change the 'destinationFormat' attribute.

[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.

Parameters
[in]valueThe new value.

◆ set_destination_uri()

void google_bigquery_api::JobConfigurationExtract::set_destination_uri ( const StringPiece &  value)
inline

Change the 'destinationUri' attribute.

[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.

Parameters
[in]valueThe new value.

◆ set_field_delimiter()

void google_bigquery_api::JobConfigurationExtract::set_field_delimiter ( const StringPiece &  value)
inline

Change the 'fieldDelimiter' attribute.

[Optional] Delimiter to use between fields in the exported data. Default is ','.

Parameters
[in]valueThe new value.

◆ set_print_header()

void google_bigquery_api::JobConfigurationExtract::set_print_header ( bool  value)
inline

Change the 'printHeader' attribute.

[Optional] Whether to print out a header row in the results. Default is true.

Parameters
[in]valueThe new value.

◆ set_use_avro_logical_types()

void google_bigquery_api::JobConfigurationExtract::set_use_avro_logical_types ( bool  value)
inline

Change the 'useAvroLogicalTypes' attribute.

[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long).

Parameters
[in]valueThe new value.

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