Represents a Batch.
Package
@google-cloud/dataprocConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataproc.v1.IBatch);Constructs a new Batch.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBatch
Properties to set |
Properties
batchConfig
public batchConfig?: ("pysparkBatch"|"sparkBatch"|"sparkRBatch"|"sparkSqlBatch");Batch batchConfig.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Batch createTime.
creator
public creator: string;Batch creator.
environmentConfig
public environmentConfig?: (google.cloud.dataproc.v1.IEnvironmentConfig|null);Batch environmentConfig.
labels
public labels: { [k: string]: string };Batch labels.
name
public name: string;Batch name.
operation
public operation: string;Batch operation.
pysparkBatch
public pysparkBatch?: (google.cloud.dataproc.v1.IPySparkBatch|null);Batch pysparkBatch.
runtimeConfig
public runtimeConfig?: (google.cloud.dataproc.v1.IRuntimeConfig|null);Batch runtimeConfig.
runtimeInfo
public runtimeInfo?: (google.cloud.dataproc.v1.IRuntimeInfo|null);Batch runtimeInfo.
sparkBatch
public sparkBatch?: (google.cloud.dataproc.v1.ISparkBatch|null);Batch sparkBatch.
sparkRBatch
public sparkRBatch?: (google.cloud.dataproc.v1.ISparkRBatch|null);Batch sparkRBatch.
sparkSqlBatch
public sparkSqlBatch?: (google.cloud.dataproc.v1.ISparkSqlBatch|null);Batch sparkSqlBatch.
state
public state: (google.cloud.dataproc.v1.Batch.State|keyof typeof google.cloud.dataproc.v1.Batch.State);Batch state.
stateHistory
public stateHistory: google.cloud.dataproc.v1.Batch.IStateHistory[];Batch stateHistory.
stateMessage
public stateMessage: string;Batch stateMessage.
stateTime
public stateTime?: (google.protobuf.ITimestamp|null);Batch stateTime.
uuid
public uuid: string;Batch uuid.
Methods
create(properties)
public static create(properties?: google.cloud.dataproc.v1.IBatch): google.cloud.dataproc.v1.Batch;Creates a new Batch instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBatch
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Batch | Batch instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1.Batch;Decodes a Batch message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Batch | Batch |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1.Batch;Decodes a Batch message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Batch | Batch |
encode(message, writer)
public static encode(message: google.cloud.dataproc.v1.IBatch, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Batch message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBatch
Batch message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dataproc.v1.IBatch, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Batch message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBatch
Batch message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dataproc.v1.Batch;Creates a Batch message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Batch | Batch |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Batch
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Batch to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataproc.v1.Batch, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Batch message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Batch
Batch |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Batch message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|