Constructor
new Batch(propertiesopt)
Constructs a new Batch.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dataproc.v1.IBatch |
<optional> |
Properties to set |
- Implements:
-
- IBatch
Classes
Members
batchConfig
Batch batchConfig.
createTime
Batch createTime.
creator
Batch creator.
environmentConfig
Batch environmentConfig.
labels
Batch labels.
name
Batch name.
operation
Batch operation.
pysparkBatch
Batch pysparkBatch.
runtimeConfig
Batch runtimeConfig.
runtimeInfo
Batch runtimeInfo.
sparkBatch
Batch sparkBatch.
sparkRBatch
Batch sparkRBatch.
sparkSqlBatch
Batch sparkSqlBatch.
state
Batch state.
stateHistory
Batch stateHistory.
stateMessage
Batch stateMessage.
stateTime
Batch stateTime.
uuid
Batch uuid.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
PENDING |
number |
PENDING value |
RUNNING |
number |
RUNNING value |
CANCELLING |
number |
CANCELLING value |
CANCELLED |
number |
CANCELLED value |
SUCCEEDED |
number |
SUCCEEDED value |
FAILED |
number |
FAILED value |
Methods
toJSON() → {Object.<string, *>}
Converts this Batch to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.dataproc.v1.Batch}
Creates a new Batch instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dataproc.v1.IBatch |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Batch |
Batch instance |
(static) decode(reader, lengthopt) → {google.cloud.dataproc.v1.Batch}
Decodes a Batch message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Batch |
Batch |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.dataproc.v1.Batch}
Decodes a Batch message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Batch |
Batch |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Batch message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dataproc.v1.IBatch |
Batch message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Batch message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dataproc.v1.IBatch |
Batch message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.dataproc.v1.Batch}
Creates a Batch message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Batch |
Batch |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Batch
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Batch message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dataproc.v1.Batch |
Batch |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Batch message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|