Class TransferTypes.NotificationConfig (1.14.0)

Version 1.14.0

• 1.55.0 (latest)
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.0.4

public static final class TransferTypes.NotificationConfig extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.NotificationConfig

Implements

TransferTypes.NotificationConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

EVENT_TYPES_FIELD_NUMBER

public static final int EVENT_TYPES_FIELD_NUMBER

Field Value
Type	Description
int

PAYLOAD_FORMAT_FIELD_NUMBER

public static final int PAYLOAD_FORMAT_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 TransferTypes.NotificationConfig getDefaultInstance()

Returns
Type	Description
TransferTypes.NotificationConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static TransferTypes.NotificationConfig.Builder newBuilder()

Returns
Type	Description
TransferTypes.NotificationConfig.Builder

newBuilder(TransferTypes.NotificationConfig prototype)

public static TransferTypes.NotificationConfig.Builder newBuilder(TransferTypes.NotificationConfig prototype)

Parameter
Name	Description
prototype	TransferTypes.NotificationConfig

Returns
Type	Description
TransferTypes.NotificationConfig.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.NotificationConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static TransferTypes.NotificationConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.NotificationConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.NotificationConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static TransferTypes.NotificationConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.NotificationConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.NotificationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.NotificationConfig> parser()

Returns
Type	Description
Parser<NotificationConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public TransferTypes.NotificationConfig getDefaultInstanceForType()

Returns
Type	Description
TransferTypes.NotificationConfig

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.

getParserForType()

public Parser<TransferTypes.NotificationConfig> getParserForType()

Returns
Type	Description
Parser<NotificationConfig>

Overrides

GeneratedMessageV3.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TransferTypes.NotificationConfig.Builder newBuilderForType()

Returns
Type	Description
TransferTypes.NotificationConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.NotificationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
TransferTypes.NotificationConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TransferTypes.NotificationConfig.Builder toBuilder()

Returns
Type	Description
TransferTypes.NotificationConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException