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

#include <table_field_schema.h>

Inheritance diagram for google_bigquery_api::TableFieldSchema:

Classes

class  TableFieldSchemaCategories
 
class  TableFieldSchemaPolicyTags
 

Public Member Functions

 TableFieldSchema (const Json::Value &storage)
 
 TableFieldSchema (Json::Value *storage)
 
virtual ~TableFieldSchema ()
 
const StringPiece GetTypeName () const
 
bool has_categories () const
 
void clear_categories ()
 
const TableFieldSchemaCategories get_categories () const
 
TableFieldSchemaCategories mutable_categories ()
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_fields () const
 
void clear_fields ()
 
const client::JsonCppArray< TableFieldSchemaget_fields () const
 
client::JsonCppArray< TableFieldSchemamutable_fields ()
 
bool has_mode () const
 
void clear_mode ()
 
const StringPiece get_mode () const
 
void set_mode (const StringPiece &value)
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_policy_tags () const
 
void clear_policy_tags ()
 
const TableFieldSchemaPolicyTags get_policy_tags () const
 
TableFieldSchemaPolicyTags mutable_policyTags ()
 
bool has_type () const
 
void clear_type ()
 
const StringPiece get_type () const
 
void set_type (const StringPiece &value)
 

Static Public Member Functions

static TableFieldSchemaNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ TableFieldSchema() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ TableFieldSchema() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~TableFieldSchema()

google_bigquery_api::TableFieldSchema::~TableFieldSchema ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_categories()

void google_bigquery_api::TableFieldSchema::clear_categories ( )
inline

Clears the 'categories' attribute.

◆ clear_description()

void google_bigquery_api::TableFieldSchema::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_fields()

void google_bigquery_api::TableFieldSchema::clear_fields ( )
inline

Clears the 'fields' attribute.

◆ clear_mode()

void google_bigquery_api::TableFieldSchema::clear_mode ( )
inline

Clears the 'mode' attribute.

◆ clear_name()

void google_bigquery_api::TableFieldSchema::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_policy_tags()

void google_bigquery_api::TableFieldSchema::clear_policy_tags ( )
inline

Clears the 'policyTags' attribute.

◆ clear_type()

void google_bigquery_api::TableFieldSchema::clear_type ( )
inline

Clears the 'type' attribute.

◆ get_categories()

const TableFieldSchemaCategories google_bigquery_api::TableFieldSchema::get_categories ( ) const
inline

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

◆ get_description()

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

Get the value of the 'description' attribute.

◆ get_fields()

const client::JsonCppArray<TableFieldSchema > google_bigquery_api::TableFieldSchema::get_fields ( ) const

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

◆ get_mode()

const StringPiece google_bigquery_api::TableFieldSchema::get_mode ( ) const
inline

Get the value of the 'mode' attribute.

◆ get_name()

const StringPiece google_bigquery_api::TableFieldSchema::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_policy_tags()

const TableFieldSchemaPolicyTags google_bigquery_api::TableFieldSchema::get_policy_tags ( ) const
inline

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

◆ get_type()

const StringPiece google_bigquery_api::TableFieldSchema::get_type ( ) const
inline

Get the value of the 'type' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::TableFieldSchema

◆ has_categories()

bool google_bigquery_api::TableFieldSchema::has_categories ( ) const
inline

Determine if the 'categories' attribute was set.

Returns
true if the 'categories' attribute was set.

◆ has_description()

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

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_fields()

bool google_bigquery_api::TableFieldSchema::has_fields ( ) const
inline

Determine if the 'fields' attribute was set.

Returns
true if the 'fields' attribute was set.

◆ has_mode()

bool google_bigquery_api::TableFieldSchema::has_mode ( ) const
inline

Determine if the 'mode' attribute was set.

Returns
true if the 'mode' attribute was set.

◆ has_name()

bool google_bigquery_api::TableFieldSchema::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_policy_tags()

bool google_bigquery_api::TableFieldSchema::has_policy_tags ( ) const
inline

Determine if the 'policyTags' attribute was set.

Returns
true if the 'policyTags' attribute was set.

◆ has_type()

bool google_bigquery_api::TableFieldSchema::has_type ( ) const
inline

Determine if the 'type' attribute was set.

Returns
true if the 'type' attribute was set.

◆ mutable_categories()

TableFieldSchemaCategories google_bigquery_api::TableFieldSchema::mutable_categories ( )
inline

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

[Optional] The categories attached to this field, used for field-level access control.

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

◆ mutable_fields()

client::JsonCppArray<TableFieldSchema > google_bigquery_api::TableFieldSchema::mutable_fields ( )

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

[Optional] Describes the nested schema fields if the type property is set to RECORD.

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

◆ mutable_policyTags()

TableFieldSchemaPolicyTags google_bigquery_api::TableFieldSchema::mutable_policyTags ( )
inline

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

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

◆ New()

TableFieldSchema * google_bigquery_api::TableFieldSchema::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_description()

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

Change the 'description' attribute.

[Optional] The field description. The maximum length is 1,024 characters.

Parameters
[in]valueThe new value.

◆ set_mode()

void google_bigquery_api::TableFieldSchema::set_mode ( const StringPiece &  value)
inline

Change the 'mode' attribute.

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

Parameters
[in]valueThe new value.

◆ set_name()

void google_bigquery_api::TableFieldSchema::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

Parameters
[in]valueThe new value.

◆ set_type()

void google_bigquery_api::TableFieldSchema::set_type ( const StringPiece &  value)
inline

Change the 'type' attribute.

[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

Parameters
[in]valueThe new value.

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