Google Cloud Batch V1 Client - Class Message (0.2.2)

Reference documentation and code samples for the Google Cloud Batch V1 Client class Message.

Message details.

Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default.

Generated from protobuf message google.cloud.batch.v1.JobNotification.Message

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ type int

The message type.

↳ new_job_state int

The new job state.

↳ new_task_state int

The new task state.

getType

The message type.

Generated from protobuf field .google.cloud.batch.v1.JobNotification.Type type = 1;

Returns
TypeDescription
int

setType

The message type.

Generated from protobuf field .google.cloud.batch.v1.JobNotification.Type type = 1;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getNewJobState

The new job state.

Generated from protobuf field .google.cloud.batch.v1.JobStatus.State new_job_state = 2;

Returns
TypeDescription
int

setNewJobState

The new job state.

Generated from protobuf field .google.cloud.batch.v1.JobStatus.State new_job_state = 2;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getNewTaskState

The new task state.

Generated from protobuf field .google.cloud.batch.v1.TaskStatus.State new_task_state = 3;

Returns
TypeDescription
int

setNewTaskState

The new task state.

Generated from protobuf field .google.cloud.batch.v1.TaskStatus.State new_task_state = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this