dataflow  v1b3
Public Member Functions | Static Public Member Functions | List of all members
google_dataflow_api::PartialGroupByKeyInstruction Class Reference

#include <partial_group_by_key_instruction.h>

Inheritance diagram for google_dataflow_api::PartialGroupByKeyInstruction:

Public Member Functions

 PartialGroupByKeyInstruction (const Json::Value &storage)
 
 PartialGroupByKeyInstruction (Json::Value *storage)
 
virtual ~PartialGroupByKeyInstruction ()
 
const StringPiece GetTypeName () const
 
bool has_input () const
 
void clear_input ()
 
const InstructionInput get_input () const
 
InstructionInput mutable_input ()
 
bool has_input_element_codec () const
 
void clear_input_element_codec ()
 
const client::JsonCppAssociativeArray< client::JsonCppData > get_input_element_codec () const
 
client::JsonCppAssociativeArray< client::JsonCppData > mutable_inputElementCodec ()
 
bool has_original_combine_values_input_store_name () const
 
void clear_original_combine_values_input_store_name ()
 
const StringPiece get_original_combine_values_input_store_name () const
 
void set_original_combine_values_input_store_name (const StringPiece &value)
 
bool has_original_combine_values_step_name () const
 
void clear_original_combine_values_step_name ()
 
const StringPiece get_original_combine_values_step_name () const
 
void set_original_combine_values_step_name (const StringPiece &value)
 
bool has_side_inputs () const
 
void clear_side_inputs ()
 
const client::JsonCppArray< SideInputInfoget_side_inputs () const
 
client::JsonCppArray< SideInputInfomutable_sideInputs ()
 
bool has_value_combining_fn () const
 
void clear_value_combining_fn ()
 
const client::JsonCppAssociativeArray< client::JsonCppData > get_value_combining_fn () const
 
client::JsonCppAssociativeArray< client::JsonCppData > mutable_valueCombiningFn ()
 

Static Public Member Functions

static PartialGroupByKeyInstructionNew ()
 

Detailed Description

An instruction that does a partial group-by-key. One input and one output.

Constructor & Destructor Documentation

◆ PartialGroupByKeyInstruction() [1/2]

google_dataflow_api::PartialGroupByKeyInstruction::PartialGroupByKeyInstruction ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ PartialGroupByKeyInstruction() [2/2]

google_dataflow_api::PartialGroupByKeyInstruction::PartialGroupByKeyInstruction ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~PartialGroupByKeyInstruction()

google_dataflow_api::PartialGroupByKeyInstruction::~PartialGroupByKeyInstruction ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_input()

void google_dataflow_api::PartialGroupByKeyInstruction::clear_input ( )
inline

Clears the 'input' attribute.

◆ clear_input_element_codec()

void google_dataflow_api::PartialGroupByKeyInstruction::clear_input_element_codec ( )
inline

Clears the 'inputElementCodec' attribute.

◆ clear_original_combine_values_input_store_name()

void google_dataflow_api::PartialGroupByKeyInstruction::clear_original_combine_values_input_store_name ( )
inline

Clears the 'originalCombineValuesInputStoreName' attribute.

◆ clear_original_combine_values_step_name()

void google_dataflow_api::PartialGroupByKeyInstruction::clear_original_combine_values_step_name ( )
inline

Clears the 'originalCombineValuesStepName' attribute.

◆ clear_side_inputs()

void google_dataflow_api::PartialGroupByKeyInstruction::clear_side_inputs ( )
inline

Clears the 'sideInputs' attribute.

◆ clear_value_combining_fn()

void google_dataflow_api::PartialGroupByKeyInstruction::clear_value_combining_fn ( )
inline

Clears the 'valueCombiningFn' attribute.

◆ get_input()

const InstructionInput google_dataflow_api::PartialGroupByKeyInstruction::get_input ( ) const

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

◆ get_input_element_codec()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::PartialGroupByKeyInstruction::get_input_element_codec ( ) const
inline

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

◆ get_original_combine_values_input_store_name()

const StringPiece google_dataflow_api::PartialGroupByKeyInstruction::get_original_combine_values_input_store_name ( ) const
inline

Get the value of the 'originalCombineValuesInputStoreName' attribute.

◆ get_original_combine_values_step_name()

const StringPiece google_dataflow_api::PartialGroupByKeyInstruction::get_original_combine_values_step_name ( ) const
inline

Get the value of the 'originalCombineValuesStepName' attribute.

◆ get_side_inputs()

const client::JsonCppArray<SideInputInfo > google_dataflow_api::PartialGroupByKeyInstruction::get_side_inputs ( ) const

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

◆ get_value_combining_fn()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::PartialGroupByKeyInstruction::get_value_combining_fn ( ) const
inline

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

◆ GetTypeName()

const StringPiece google_dataflow_api::PartialGroupByKeyInstruction::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::PartialGroupByKeyInstruction

◆ has_input()

bool google_dataflow_api::PartialGroupByKeyInstruction::has_input ( ) const
inline

Determine if the 'input' attribute was set.

Returns
true if the 'input' attribute was set.

◆ has_input_element_codec()

bool google_dataflow_api::PartialGroupByKeyInstruction::has_input_element_codec ( ) const
inline

Determine if the 'inputElementCodec' attribute was set.

Returns
true if the 'inputElementCodec' attribute was set.

◆ has_original_combine_values_input_store_name()

bool google_dataflow_api::PartialGroupByKeyInstruction::has_original_combine_values_input_store_name ( ) const
inline

Determine if the 'originalCombineValuesInputStoreName' attribute was set.

Returns
true if the 'originalCombineValuesInputStoreName' attribute was set.

◆ has_original_combine_values_step_name()

bool google_dataflow_api::PartialGroupByKeyInstruction::has_original_combine_values_step_name ( ) const
inline

Determine if the 'originalCombineValuesStepName' attribute was set.

Returns
true if the 'originalCombineValuesStepName' attribute was set.

◆ has_side_inputs()

bool google_dataflow_api::PartialGroupByKeyInstruction::has_side_inputs ( ) const
inline

Determine if the 'sideInputs' attribute was set.

Returns
true if the 'sideInputs' attribute was set.

◆ has_value_combining_fn()

bool google_dataflow_api::PartialGroupByKeyInstruction::has_value_combining_fn ( ) const
inline

Determine if the 'valueCombiningFn' attribute was set.

Returns
true if the 'valueCombiningFn' attribute was set.

◆ mutable_input()

InstructionInput google_dataflow_api::PartialGroupByKeyInstruction::mutable_input ( )

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

Describes the input to the partial group-by-key instruction.

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

◆ mutable_inputElementCodec()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::PartialGroupByKeyInstruction::mutable_inputElementCodec ( )
inline

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

The codec to use for interpreting an element in the input PTable.

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

◆ mutable_sideInputs()

client::JsonCppArray<SideInputInfo > google_dataflow_api::PartialGroupByKeyInstruction::mutable_sideInputs ( )

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

Zero or more side inputs.

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

◆ mutable_valueCombiningFn()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::PartialGroupByKeyInstruction::mutable_valueCombiningFn ( )
inline

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

The value combining function to invoke.

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

◆ New()

PartialGroupByKeyInstruction * google_dataflow_api::PartialGroupByKeyInstruction::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_original_combine_values_input_store_name()

void google_dataflow_api::PartialGroupByKeyInstruction::set_original_combine_values_input_store_name ( const StringPiece &  value)
inline

Change the 'originalCombineValuesInputStoreName' attribute.

If this instruction includes a combining function this is the name of the intermediate store between the GBK and the CombineValues.

Parameters
[in]valueThe new value.

◆ set_original_combine_values_step_name()

void google_dataflow_api::PartialGroupByKeyInstruction::set_original_combine_values_step_name ( const StringPiece &  value)
inline

Change the 'originalCombineValuesStepName' attribute.

If this instruction includes a combining function, this is the name of the CombineValues instruction lifted into this instruction.

Parameters
[in]valueThe new value.

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