Send feedback
Class TransferTypes.NotificationConfig (1.11.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.11.0 keyboard_arrow_down
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
Static Fields
EVENT_TYPES_FIELD_NUMBER
public static final int EVENT_TYPES_FIELD_NUMBER
Field Value
public static final int PAYLOAD_FORMAT_FIELD_NUMBER
Field Value
PUBSUB_TOPIC_FIELD_NUMBER
public static final int PUBSUB_TOPIC_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TransferTypes . NotificationConfig getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static TransferTypes . NotificationConfig . Builder newBuilder ()
Returns
newBuilder(TransferTypes.NotificationConfig prototype)
public static TransferTypes . NotificationConfig . Builder newBuilder ( TransferTypes . NotificationConfig prototype )
Parameter
Returns
public static TransferTypes . NotificationConfig parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static TransferTypes . NotificationConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransferTypes . NotificationConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes . NotificationConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransferTypes . NotificationConfig parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes . NotificationConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static TransferTypes . NotificationConfig parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static TransferTypes . NotificationConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static TransferTypes . NotificationConfig parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static TransferTypes . NotificationConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransferTypes . NotificationConfig parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes . NotificationConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<TransferTypes . NotificationConfig > parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public TransferTypes . NotificationConfig getDefaultInstanceForType ()
Returns
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
indexint The index of the element to return.
Returns
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
indexint 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
Overrides
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
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public TransferTypes . NotificationConfig . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes . NotificationConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public TransferTypes . NotificationConfig . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
