Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::PigJob.
A Dataproc job for running Apache Pig
queries on YARN.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#continue_on_failure
defcontinue_on_failure()->::Boolean
Returns
(::Boolean) — Optional. Whether to continue executing queries if a query fails.
The default value is false. Setting to true can be useful when
executing independent parallel queries.
#continue_on_failure=
defcontinue_on_failure=(value)->::Boolean
Parameter
value (::Boolean) — Optional. Whether to continue executing queries if a query fails.
The default value is false. Setting to true can be useful when
executing independent parallel queries.
Returns
(::Boolean) — Optional. Whether to continue executing queries if a query fails.
The default value is false. Setting to true can be useful when
executing independent parallel queries.
#jar_file_uris
defjar_file_uris()->::Array<::String>
Returns
(::Array<::String>) — Optional. HCFS URIs of jar files to add to the CLASSPATH of
the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
#jar_file_uris=
defjar_file_uris=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Optional. HCFS URIs of jar files to add to the CLASSPATH of
the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
Returns
(::Array<::String>) — Optional. HCFS URIs of jar files to add to the CLASSPATH of
the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
(::Google::Protobuf::Map{::String => ::String}) — Optional. A mapping of property names to values, used to configure Pig.
Properties that conflict with values set by the Dataproc API might be
overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml,
/etc/pig/conf/pig.properties, and classes in user code.
value (::Google::Protobuf::Map{::String => ::String}) — Optional. A mapping of property names to values, used to configure Pig.
Properties that conflict with values set by the Dataproc API might be
overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml,
/etc/pig/conf/pig.properties, and classes in user code.
Returns
(::Google::Protobuf::Map{::String => ::String}) — Optional. A mapping of property names to values, used to configure Pig.
Properties that conflict with values set by the Dataproc API might be
overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml,
/etc/pig/conf/pig.properties, and classes in user code.
#query_file_uri
defquery_file_uri()->::String
Returns
(::String) — The HCFS URI of the script that contains the Pig queries.
Note: The following fields are mutually exclusive: query_file_uri, query_list. If a field in that set is populated, all other fields in the set will automatically be cleared.
#query_file_uri=
defquery_file_uri=(value)->::String
Parameter
value (::String) — The HCFS URI of the script that contains the Pig queries.
Note: The following fields are mutually exclusive: query_file_uri, query_list. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — The HCFS URI of the script that contains the Pig queries.
Note: The following fields are mutually exclusive: query_file_uri, query_list. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: query_list, query_file_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: query_list, query_file_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: query_list, query_file_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.
value (::Google::Protobuf::Map{::String => ::String}) — Optional. Mapping of query variable names to values (equivalent to the Pig
command: name=[value]).
Returns
(::Google::Protobuf::Map{::String => ::String}) — Optional. Mapping of query variable names to values (equivalent to the Pig
command: name=[value]).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::PigJob (v1.6.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.0 (latest)](/ruby/docs/reference/google-cloud-dataproc-v1/latest/Google-Cloud-Dataproc-V1-PigJob)\n- [1.5.0](/ruby/docs/reference/google-cloud-dataproc-v1/1.5.0/Google-Cloud-Dataproc-V1-PigJob)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataproc-v1/1.4.0/Google-Cloud-Dataproc-V1-PigJob)\n- [1.3.1](/ruby/docs/reference/google-cloud-dataproc-v1/1.3.1/Google-Cloud-Dataproc-V1-PigJob)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataproc-v1/1.2.0/Google-Cloud-Dataproc-V1-PigJob)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataproc-v1/1.1.0/Google-Cloud-Dataproc-V1-PigJob)\n- [1.0.2](/ruby/docs/reference/google-cloud-dataproc-v1/1.0.2/Google-Cloud-Dataproc-V1-PigJob)\n- [0.26.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.26.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.25.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.25.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.24.1](/ruby/docs/reference/google-cloud-dataproc-v1/0.24.1/Google-Cloud-Dataproc-V1-PigJob)\n- [0.23.1](/ruby/docs/reference/google-cloud-dataproc-v1/0.23.1/Google-Cloud-Dataproc-V1-PigJob)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.22.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.21.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.21.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.20.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.19.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.18.1](/ruby/docs/reference/google-cloud-dataproc-v1/0.18.1/Google-Cloud-Dataproc-V1-PigJob)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.17.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.16.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.15.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.14.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.13.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.12.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.11.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.10.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.9.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataproc-v1/0.8.0/Google-Cloud-Dataproc-V1-PigJob)\n- [0.7.1](/ruby/docs/reference/google-cloud-dataproc-v1/0.7.1/Google-Cloud-Dataproc-V1-PigJob) \nReference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::PigJob.\n\nA Dataproc job for running [Apache Pig](https://pig.apache.org/)\nqueries on YARN. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #continue_on_failure\n\n def continue_on_failure() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.\n\n### #continue_on_failure=\n\n def continue_on_failure=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries. \n**Returns**\n\n- (::Boolean) --- Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.\n\n### #jar_file_uris\n\n def jar_file_uris() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.\n\n### #jar_file_uris=\n\n def jar_file_uris=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.\n\n### #logging_config\n\n def logging_config() -\u003e ::Google::Cloud::Dataproc::V1::LoggingConfig\n\n**Returns**\n\n- ([::Google::Cloud::Dataproc::V1::LoggingConfig](./Google-Cloud-Dataproc-V1-LoggingConfig)) --- Optional. The runtime log config for job execution.\n\n### #logging_config=\n\n def logging_config=(value) -\u003e ::Google::Cloud::Dataproc::V1::LoggingConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataproc::V1::LoggingConfig](./Google-Cloud-Dataproc-V1-LoggingConfig)) --- Optional. The runtime log config for job execution. \n**Returns**\n\n- ([::Google::Cloud::Dataproc::V1::LoggingConfig](./Google-Cloud-Dataproc-V1-LoggingConfig)) --- Optional. The runtime log config for job execution.\n\n### #properties\n\n def properties() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`, /etc/pig/conf/pig.properties, and classes in user code.\n\n### #properties=\n\n def properties=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`, /etc/pig/conf/pig.properties, and classes in user code. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`, /etc/pig/conf/pig.properties, and classes in user code.\n\n### #query_file_uri\n\n def query_file_uri() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The HCFS URI of the script that contains the Pig queries.\n\n Note: The following fields are mutually exclusive: `query_file_uri`, `query_list`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #query_file_uri=\n\n def query_file_uri=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The HCFS URI of the script that contains the Pig queries.\n\n\nNote: The following fields are mutually exclusive: `query_file_uri`, `query_list`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- The HCFS URI of the script that contains the Pig queries.\n\n Note: The following fields are mutually exclusive: `query_file_uri`, `query_list`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #query_list\n\n def query_list() -\u003e ::Google::Cloud::Dataproc::V1::QueryList\n\n**Returns**\n\n- ([::Google::Cloud::Dataproc::V1::QueryList](./Google-Cloud-Dataproc-V1-QueryList)) --- A list of queries.\n\n\n Note: The following fields are mutually exclusive: `query_list`, `query_file_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #query_list=\n\n def query_list=(value) -\u003e ::Google::Cloud::Dataproc::V1::QueryList\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataproc::V1::QueryList](./Google-Cloud-Dataproc-V1-QueryList)) --- A list of queries.\n\n\nNote: The following fields are mutually exclusive: `query_list`, `query_file_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Dataproc::V1::QueryList](./Google-Cloud-Dataproc-V1-QueryList)) --- A list of queries.\n\n\n Note: The following fields are mutually exclusive: `query_list`, `query_file_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #script_variables\n\n def script_variables() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).\n\n### #script_variables=\n\n def script_variables=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`). \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`)."]]