com.google.storagetransfer.v1.proto

Interface TransferTypes.NotificationConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransferTypes.NotificationConfig, TransferTypes.NotificationConfig.Builder

Enclosing class:

TransferTypes

public static interface TransferTypes.NotificationConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
TransferTypes.NotificationConfig.EventType	getEventTypes(int index) Event types for which a notification is desired.
int	getEventTypesCount() Event types for which a notification is desired.
List<TransferTypes.NotificationConfig.EventType>	getEventTypesList() Event types for which a notification is desired.
int	getEventTypesValue(int index) Event types for which a notification is desired.
List<Integer>	getEventTypesValueList() Event types for which a notification is desired.
TransferTypes.NotificationConfig.PayloadFormat	getPayloadFormat() Required.
int	getPayloadFormatValue() Required.
String	getPubsubTopic() Required.
com.google.protobuf.ByteString	getPubsubTopicBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPubsubTopic

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

Returns:

The pubsubTopic.

getPubsubTopicBytes

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

Returns:

The bytes for pubsubTopic.

getEventTypesList

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:

A list containing the eventTypes.

getEventTypesCount

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:

The count of eventTypes.

getEventTypes

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;

Parameters:

index - The index of the element to return.

Returns:

The eventTypes at the given index.

getEventTypesValueList

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:

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

getEventTypesValue

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;

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of eventTypes at the given index.

getPayloadFormatValue

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:

The enum numeric value on the wire for payloadFormat.

getPayloadFormat

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:

The payloadFormat.