public static final class TransferTypes.NotificationConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder> 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.NotificationConfiggetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic TransferTypes.NotificationConfig build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic TransferTypes.NotificationConfig buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic TransferTypes.NotificationConfig.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder mergeFrom(TransferTypes.NotificationConfig other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public TransferTypes.NotificationConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.NotificationConfig.Builder>IOExceptionpublic 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];getPubsubTopic in interface TransferTypes.NotificationConfigOrBuilderpublic 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];getPubsubTopicBytes in interface TransferTypes.NotificationConfigOrBuilderpublic TransferTypes.NotificationConfig.Builder setPubsubTopic(String value)
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];value - The pubsubTopic to set.public TransferTypes.NotificationConfig.Builder clearPubsubTopic()
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];public TransferTypes.NotificationConfig.Builder setPubsubTopicBytes(com.google.protobuf.ByteString value)
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];value - The bytes for pubsubTopic to set.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;
getEventTypesList in interface TransferTypes.NotificationConfigOrBuilderpublic 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;
getEventTypesCount in interface TransferTypes.NotificationConfigOrBuilderpublic 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;
getEventTypes in interface TransferTypes.NotificationConfigOrBuilderindex - The index of the element to return.public TransferTypes.NotificationConfig.Builder setEventTypes(int index, TransferTypes.NotificationConfig.EventType value)
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;
index - The index to set the value at.value - The eventTypes to set.public TransferTypes.NotificationConfig.Builder addEventTypes(TransferTypes.NotificationConfig.EventType value)
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;
value - The eventTypes to add.public TransferTypes.NotificationConfig.Builder addAllEventTypes(Iterable<? extends TransferTypes.NotificationConfig.EventType> values)
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;
values - The eventTypes to add.public TransferTypes.NotificationConfig.Builder clearEventTypes()
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;
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;
getEventTypesValueList in interface TransferTypes.NotificationConfigOrBuilderpublic 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;
getEventTypesValue in interface TransferTypes.NotificationConfigOrBuilderindex - The index of the value to return.public TransferTypes.NotificationConfig.Builder setEventTypesValue(int index, int value)
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;
index - The index to set the value at.value - The enum numeric value on the wire for eventTypes to set.public TransferTypes.NotificationConfig.Builder addEventTypesValue(int value)
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;
value - The enum numeric value on the wire for eventTypes to add.public TransferTypes.NotificationConfig.Builder addAllEventTypesValue(Iterable<Integer> values)
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;
values - The enum numeric values on the wire for eventTypes to add.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];
getPayloadFormatValue in interface TransferTypes.NotificationConfigOrBuilderpublic TransferTypes.NotificationConfig.Builder setPayloadFormatValue(int value)
Required. The desired format of the notification message payloads.
.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];
value - The enum numeric value on the wire for payloadFormat to set.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];
getPayloadFormat in interface TransferTypes.NotificationConfigOrBuilderpublic TransferTypes.NotificationConfig.Builder setPayloadFormat(TransferTypes.NotificationConfig.PayloadFormat value)
Required. The desired format of the notification message payloads.
.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];
value - The payloadFormat to set.public TransferTypes.NotificationConfig.Builder clearPayloadFormat()
Required. The desired format of the notification message payloads.
.google.storagetransfer.v1.NotificationConfig.PayloadFormat payload_format = 3 [(.google.api.field_behavior) = REQUIRED];
public final TransferTypes.NotificationConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>public final TransferTypes.NotificationConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.NotificationConfig.Builder>Copyright © 2022 Google LLC. All rights reserved.