Class TransferTypes.NotificationConfig.Builder (1.42.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

Implements

TransferTypes.NotificationConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.NotificationConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`TransferTypes.NotificationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TransferTypes.NotificationConfig getDefaultInstanceForType()

Returns
Type	Description
`TransferTypes.NotificationConfig`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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()

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

Returns
Type	Description
`String`	The pubsubTopic.

getPubsubTopicBytes()

public ByteString getPubsubTopicBytes()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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)

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)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.NotificationConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`TransferTypes.NotificationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)