Class JobNotification (0.55.0)

public final class JobNotification extends GeneratedMessageV3 implements JobNotificationOrBuilder

Notification configurations.

Protobuf type google.cloud.batch.v1.JobNotification

Static Fields

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

PUBSUB_TOPIC_FIELD_NUMBER

public static final int PUBSUB_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static JobNotification getDefaultInstance()
Returns
Type Description
JobNotification

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static JobNotification.Builder newBuilder()
Returns
Type Description
JobNotification.Builder

newBuilder(JobNotification prototype)

public static JobNotification.Builder newBuilder(JobNotification prototype)
Parameter
Name Description
prototype JobNotification
Returns
Type Description
JobNotification.Builder

parseDelimitedFrom(InputStream input)

public static JobNotification parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JobNotification
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobNotification parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobNotification
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static JobNotification parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
JobNotification
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JobNotification parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobNotification
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JobNotification parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
JobNotification
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JobNotification parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobNotification
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JobNotification parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
JobNotification
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JobNotification parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobNotification
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static JobNotification parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JobNotification
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobNotification parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobNotification
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static JobNotification parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
JobNotification
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JobNotification parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobNotification
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<JobNotification> parser()
Returns
Type Description
Parser<JobNotification>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public JobNotification getDefaultInstanceForType()
Returns
Type Description
JobNotification

getMessage()

public JobNotification.Message getMessage()

The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.

.google.cloud.batch.v1.JobNotification.Message message = 2;

Returns
Type Description
JobNotification.Message

The message.

getMessageOrBuilder()

public JobNotification.MessageOrBuilder getMessageOrBuilder()

The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.

.google.cloud.batch.v1.JobNotification.Message message = 2;

Returns
Type Description
JobNotification.MessageOrBuilder

getParserForType()

public Parser<JobNotification> getParserForType()
Returns
Type Description
Parser<JobNotification>
Overrides

getPubsubTopic()

public String getPubsubTopic()

The Pub/Sub topic where notifications for the job, like state changes, will be published. If undefined, no Pub/Sub notifications are sent for this job.

Specify the topic using the following format: projects/{project}/topics/{topic}. Notably, if you want to specify a Pub/Sub topic that is in a different project than the job, your administrator must grant your project's Batch service agent permission to publish to that topic.

For more information about configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-notifications.

string pubsub_topic = 1;

Returns
Type Description
String

The pubsubTopic.

getPubsubTopicBytes()

public ByteString getPubsubTopicBytes()

The Pub/Sub topic where notifications for the job, like state changes, will be published. If undefined, no Pub/Sub notifications are sent for this job.

Specify the topic using the following format: projects/{project}/topics/{topic}. Notably, if you want to specify a Pub/Sub topic that is in a different project than the job, your administrator must grant your project's Batch service agent permission to publish to that topic.

For more information about configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-notifications.

string pubsub_topic = 1;

Returns
Type Description
ByteString

The bytes for pubsubTopic.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMessage()

public boolean hasMessage()

The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.

.google.cloud.batch.v1.JobNotification.Message message = 2;

Returns
Type Description
boolean

Whether the message field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public JobNotification.Builder newBuilderForType()
Returns
Type Description
JobNotification.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected JobNotification.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
JobNotification.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public JobNotification.Builder toBuilder()
Returns
Type Description
JobNotification.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException