Class TransferTypes.NotificationConfig.Builder (1.47.0) 

public static final class TransferTypes.NotificationConfig.Builder extends GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder> implements TransferTypes.NotificationConfigOrBuilder

Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes:

  • "eventType": one of the EventType values
  • "payloadFormat": one of the PayloadFormat values
  • "projectId": the project_id of the TransferOperation
  • "transferJobName": the transfer_job_name of the TransferOperation

  • "transferOperationName": the name of the TransferOperation

    The PubsubMessage.data contains a TransferOperation resource formatted according to the specified PayloadFormat.

Protobuf type google.storagetransfer.v1.NotificationConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferTypes.NotificationConfig.Builder

Static Methods

getDescriptor()

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

Methods

addAllEventTypes(Iterable<? extends TransferTypes.NotificationConfig.EventType> values)

public TransferTypes.NotificationConfig.Builder addAllEventTypes(Iterable<? extends TransferTypes.NotificationConfig.EventType> values)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameter
Name Description
values Iterable<? extends com.google.storagetransfer.v1.proto.TransferTypes.NotificationConfig.EventType>

The eventTypes to add.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

addAllEventTypesValue(Iterable<Integer> values)

public TransferTypes.NotificationConfig.Builder addAllEventTypesValue(Iterable<Integer> values)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for eventTypes to add.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

addEventTypes(TransferTypes.NotificationConfig.EventType value)

public TransferTypes.NotificationConfig.Builder addEventTypes(TransferTypes.NotificationConfig.EventType value)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameter
Name Description
value TransferTypes.NotificationConfig.EventType

The eventTypes to add.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

addEventTypesValue(int value)

public TransferTypes.NotificationConfig.Builder addEventTypesValue(int value)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for eventTypes to add.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.NotificationConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

build()

public TransferTypes.NotificationConfig build()
Returns
Type Description
TransferTypes.NotificationConfig

buildPartial()

public TransferTypes.NotificationConfig buildPartial()
Returns
Type Description
TransferTypes.NotificationConfig

clear()

public TransferTypes.NotificationConfig.Builder clear()
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

clearEventTypes()

public TransferTypes.NotificationConfig.Builder clearEventTypes()

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.NotificationConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.NotificationConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

clearPayloadFormat()

public TransferTypes.NotificationConfig.Builder clearPayloadFormat()

Required. The desired format of the notification message payloads.

.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

clearPubsubTopic()

public TransferTypes.NotificationConfig.Builder clearPubsubTopic()

Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.

string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

clone()

public TransferTypes.NotificationConfig.Builder clone()
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

getDefaultInstanceForType()

public TransferTypes.NotificationConfig getDefaultInstanceForType()
Returns
Type Description
TransferTypes.NotificationConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEventTypes(int index)

public TransferTypes.NotificationConfig.EventType getEventTypes(int index)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
TransferTypes.NotificationConfig.EventType

The eventTypes at the given index.

getEventTypesCount()

public int getEventTypesCount()

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Returns
Type Description
int

The count of eventTypes.

getEventTypesList()

public List<TransferTypes.NotificationConfig.EventType> getEventTypesList()

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Returns
Type Description
List<EventType>

A list containing the eventTypes.

getEventTypesValue(int index)

public int getEventTypesValue(int index)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of eventTypes at the given index.

getEventTypesValueList()

public List<Integer> getEventTypesValueList()

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for eventTypes.

getPayloadFormat()

public TransferTypes.NotificationConfig.PayloadFormat getPayloadFormat()

Required. The desired format of the notification message payloads.

.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.NotificationConfig.PayloadFormat

The payloadFormat.

getPayloadFormatValue()

public int getPayloadFormatValue()

Required. The desired format of the notification message payloads.

.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for payloadFormat.

getPubsubTopic()

public String getPubsubTopic()

Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.

string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The pubsubTopic.

getPubsubTopicBytes()

public ByteString getPubsubTopicBytes()

Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.

string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for pubsubTopic.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.NotificationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.NotificationConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

mergeFrom(TransferTypes.NotificationConfig other)

public TransferTypes.NotificationConfig.Builder mergeFrom(TransferTypes.NotificationConfig other)
Parameter
Name Description
other TransferTypes.NotificationConfig
Returns
Type Description
TransferTypes.NotificationConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.NotificationConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

setEventTypes(int index, TransferTypes.NotificationConfig.EventType value)

public TransferTypes.NotificationConfig.Builder setEventTypes(int index, TransferTypes.NotificationConfig.EventType value)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameters
Name Description
index int

The index to set the value at.
value TransferTypes.NotificationConfig.EventType

The eventTypes to set.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

setEventTypesValue(int index, int value)

public TransferTypes.NotificationConfig.Builder setEventTypesValue(int index, int value)

Event types for which a notification is desired. If empty, send notifications for all event types.

repeated .google.storagetransfer.v1.NotificationConfig.EventType event_types = 2;

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for eventTypes to set.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.NotificationConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

setPayloadFormat(TransferTypes.NotificationConfig.PayloadFormat value)

public TransferTypes.NotificationConfig.Builder setPayloadFormat(TransferTypes.NotificationConfig.PayloadFormat value)

Required. The desired format of the notification message payloads.

.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value TransferTypes.NotificationConfig.PayloadFormat

The payloadFormat to set.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

setPayloadFormatValue(int value)

public TransferTypes.NotificationConfig.Builder setPayloadFormatValue(int value)

Required. The desired format of the notification message payloads.

.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for payloadFormat to set.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

setPubsubTopic(String value)

public TransferTypes.NotificationConfig.Builder setPubsubTopic(String value)

Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.

string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The pubsubTopic to set.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

setPubsubTopicBytes(ByteString value)

public TransferTypes.NotificationConfig.Builder setPubsubTopicBytes(ByteString value)

Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.

string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for pubsubTopic to set.
Returns
Type Description
TransferTypes.NotificationConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.NotificationConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.NotificationConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.NotificationConfig.Builder
Overrides