Class TransferTypes.NotificationConfig (1.37.0)

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

Static Fields

EVENT_TYPES_FIELD_NUMBER

public static final int EVENT_TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

PAYLOAD_FORMAT_FIELD_NUMBER

public static final int PAYLOAD_FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

PUBSUB_TOPIC_FIELD_NUMBER

public static final int PUBSUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransferTypes.NotificationConfig getDefaultInstance()
Returns
TypeDescription
TransferTypes.NotificationConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransferTypes.NotificationConfig.Builder newBuilder()
Returns
TypeDescription
TransferTypes.NotificationConfig.Builder

newBuilder(TransferTypes.NotificationConfig prototype)

public static TransferTypes.NotificationConfig.Builder newBuilder(TransferTypes.NotificationConfig prototype)
Parameter
NameDescription
prototypeTransferTypes.NotificationConfig
Returns
TypeDescription
TransferTypes.NotificationConfig.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.NotificationConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransferTypes.NotificationConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.NotificationConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.NotificationConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransferTypes.NotificationConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.NotificationConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.NotificationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.NotificationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.NotificationConfig> parser()
Returns
TypeDescription
Parser<NotificationConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TransferTypes.NotificationConfig getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
List<Integer>

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

getParserForType()

public Parser<TransferTypes.NotificationConfig> getParserForType()
Returns
TypeDescription
Parser<NotificationConfig>
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pubsubTopic.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransferTypes.NotificationConfig.Builder newBuilderForType()
Returns
TypeDescription
TransferTypes.NotificationConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.NotificationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransferTypes.NotificationConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransferTypes.NotificationConfig.Builder toBuilder()
Returns
TypeDescription
TransferTypes.NotificationConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException