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

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

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

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

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
Exceptions
Type Description
IOException