Package com.google.storagetransfer.v1.proto

Class TransferTypes.NotificationConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.storagetransfer.v1.proto.TransferTypes.NotificationConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.NotificationConfigOrBuilder, Serializable
Enclosing class:
TransferTypes
public static final class TransferTypes.NotificationConfig extends com.google.protobuf.GeneratedMessage 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][google.storagetransfer.v1.NotificationConfig.EventType] values
 * `"payloadFormat"`: one of the
 [PayloadFormat][google.storagetransfer.v1.NotificationConfig.PayloadFormat]
 values
 * `"projectId"`: the
 [project_id][google.storagetransfer.v1.TransferOperation.project_id] of the
 `TransferOperation`
 * `"transferJobName"`: the
 [transfer_job_name][google.storagetransfer.v1.TransferOperation.transfer_job_name]
 of the `TransferOperation`
 * `"transferOperationName"`: the
 [name][google.storagetransfer.v1.TransferOperation.name] of the
 `TransferOperation`

 The `PubsubMessage.data` contains a
 [TransferOperation][google.storagetransfer.v1.TransferOperation] resource
 formatted according to the specified `PayloadFormat`.
Protobuf type google.storagetransfer.v1.NotificationConfig
See Also:

  • Field Details

    • PUBSUB_TOPIC_FIELD_NUMBER

      public static final int PUBSUB_TOPIC_FIELD_NUMBER
      See Also:

    • EVENT_TYPES_FIELD_NUMBER

      public static final int EVENT_TYPES_FIELD_NUMBER
      See Also:

    • PAYLOAD_FORMAT_FIELD_NUMBER

      public static final int PAYLOAD_FORMAT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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][google.rpc.Code.INVALID_ARGUMENT] error.
      string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPubsubTopic in interface TransferTypes.NotificationConfigOrBuilder
      Returns:
      The pubsubTopic.

    • getPubsubTopicBytes

      public com.google.protobuf.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][google.rpc.Code.INVALID_ARGUMENT] error.
      string pubsub_topic = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPubsubTopicBytes in interface TransferTypes.NotificationConfigOrBuilder
      Returns:
      The bytes for pubsubTopic.

    • 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;
      Specified by:
      getEventTypesList in interface TransferTypes.NotificationConfigOrBuilder
      Returns:
      A list containing the eventTypes.

    • 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;
      Specified by:
      getEventTypesCount in interface TransferTypes.NotificationConfigOrBuilder
      Returns:
      The count of eventTypes.

    • getEventTypes

      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;
      Specified by:
      getEventTypes in interface TransferTypes.NotificationConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The 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;
      Specified by:
      getEventTypesValueList in interface TransferTypes.NotificationConfigOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for eventTypes.

    • getEventTypesValue

      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;
      Specified by:
      getEventTypesValue in interface TransferTypes.NotificationConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of eventTypes at the given index.

    • 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];
      Specified by:
      getPayloadFormatValue in interface TransferTypes.NotificationConfigOrBuilder
      Returns:
      The enum numeric value on the wire for payloadFormat.

    • 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];
      Specified by:
      getPayloadFormat in interface TransferTypes.NotificationConfigOrBuilder
      Returns:
      The payloadFormat.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferTypes.NotificationConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferTypes.NotificationConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.NotificationConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TransferTypes.NotificationConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TransferTypes.NotificationConfig.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public TransferTypes.NotificationConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TransferTypes.NotificationConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TransferTypes.NotificationConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransferTypes.NotificationConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<TransferTypes.NotificationConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public TransferTypes.NotificationConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder