public static final class NotificationConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder> implements NotificationConfigOrBuilder
A directive to publish Pub/Sub notifications upon changes to a bucket.Protobuf type
google.storage.v2.NotificationConfig
Modifier and Type | Method and Description |
---|---|
NotificationConfig.Builder |
addAllEventTypes(Iterable<String> values)
If present, only send notifications about listed event types.
|
NotificationConfig.Builder |
addEventTypes(String value)
If present, only send notifications about listed event types.
|
NotificationConfig.Builder |
addEventTypesBytes(com.google.protobuf.ByteString value)
If present, only send notifications about listed event types.
|
NotificationConfig.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
NotificationConfig |
build() |
NotificationConfig |
buildPartial() |
NotificationConfig.Builder |
clear() |
NotificationConfig.Builder |
clearCustomAttributes() |
NotificationConfig.Builder |
clearEtag()
The etag of the NotificationConfig.
|
NotificationConfig.Builder |
clearEventTypes()
If present, only send notifications about listed event types.
|
NotificationConfig.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
NotificationConfig.Builder |
clearName()
Required.
|
NotificationConfig.Builder |
clearObjectNamePrefix()
If present, only apply this NotificationConfig to object names that
begin with this prefix.
|
NotificationConfig.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
NotificationConfig.Builder |
clearPayloadFormat()
Required.
|
NotificationConfig.Builder |
clearTopic()
Required.
|
NotificationConfig.Builder |
clone() |
boolean |
containsCustomAttributes(String key)
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
Map<String,String> |
getCustomAttributes()
Deprecated.
|
int |
getCustomAttributesCount()
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
Map<String,String> |
getCustomAttributesMap()
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
String |
getCustomAttributesOrDefault(String key,
String defaultValue)
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
String |
getCustomAttributesOrThrow(String key)
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
NotificationConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getEtag()
The etag of the NotificationConfig.
|
com.google.protobuf.ByteString |
getEtagBytes()
The etag of the NotificationConfig.
|
String |
getEventTypes(int index)
If present, only send notifications about listed event types.
|
com.google.protobuf.ByteString |
getEventTypesBytes(int index)
If present, only send notifications about listed event types.
|
int |
getEventTypesCount()
If present, only send notifications about listed event types.
|
com.google.protobuf.ProtocolStringList |
getEventTypesList()
If present, only send notifications about listed event types.
|
Map<String,String> |
getMutableCustomAttributes()
Deprecated.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
String |
getObjectNamePrefix()
If present, only apply this NotificationConfig to object names that
begin with this prefix.
|
com.google.protobuf.ByteString |
getObjectNamePrefixBytes()
If present, only apply this NotificationConfig to object names that
begin with this prefix.
|
String |
getPayloadFormat()
Required.
|
com.google.protobuf.ByteString |
getPayloadFormatBytes()
Required.
|
String |
getTopic()
Required.
|
com.google.protobuf.ByteString |
getTopicBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
NotificationConfig.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
NotificationConfig.Builder |
mergeFrom(com.google.protobuf.Message other) |
NotificationConfig.Builder |
mergeFrom(NotificationConfig other) |
NotificationConfig.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
NotificationConfig.Builder |
putAllCustomAttributes(Map<String,String> values)
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
NotificationConfig.Builder |
putCustomAttributes(String key,
String value)
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
NotificationConfig.Builder |
removeCustomAttributes(String key)
A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
|
NotificationConfig.Builder |
setEtag(String value)
The etag of the NotificationConfig.
|
NotificationConfig.Builder |
setEtagBytes(com.google.protobuf.ByteString value)
The etag of the NotificationConfig.
|
NotificationConfig.Builder |
setEventTypes(int index,
String value)
If present, only send notifications about listed event types.
|
NotificationConfig.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
NotificationConfig.Builder |
setName(String value)
Required.
|
NotificationConfig.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Required.
|
NotificationConfig.Builder |
setObjectNamePrefix(String value)
If present, only apply this NotificationConfig to object names that
begin with this prefix.
|
NotificationConfig.Builder |
setObjectNamePrefixBytes(com.google.protobuf.ByteString value)
If present, only apply this NotificationConfig to object names that
begin with this prefix.
|
NotificationConfig.Builder |
setPayloadFormat(String value)
Required.
|
NotificationConfig.Builder |
setPayloadFormatBytes(com.google.protobuf.ByteString value)
Required.
|
NotificationConfig.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
NotificationConfig.Builder |
setTopic(String value)
Required.
|
NotificationConfig.Builder |
setTopicBytes(com.google.protobuf.ByteString value)
Required.
|
NotificationConfig.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public NotificationConfig build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public NotificationConfig buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public NotificationConfig.Builder clone()
clone
in interface com.google.protobuf.Message.Builder
clone
in interface com.google.protobuf.MessageLite.Builder
clone
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField
in interface com.google.protobuf.Message.Builder
setField
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField
in interface com.google.protobuf.Message.Builder
clearField
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof
in interface com.google.protobuf.Message.Builder
clearOneof
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField
in interface com.google.protobuf.Message.Builder
setRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField
in interface com.google.protobuf.Message.Builder
addRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder mergeFrom(NotificationConfig other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public NotificationConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<NotificationConfig.Builder>
IOException
public String getName()
Required. The resource name of this NotificationConfig. Format: `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}` The `{project}` portion may be `_` for globally unique buckets.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
getName
in interface NotificationConfigOrBuilder
public com.google.protobuf.ByteString getNameBytes()
Required. The resource name of this NotificationConfig. Format: `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}` The `{project}` portion may be `_` for globally unique buckets.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
getNameBytes
in interface NotificationConfigOrBuilder
public NotificationConfig.Builder setName(String value)
Required. The resource name of this NotificationConfig. Format: `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}` The `{project}` portion may be `_` for globally unique buckets.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
value
- The name to set.public NotificationConfig.Builder clearName()
Required. The resource name of this NotificationConfig. Format: `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}` The `{project}` portion may be `_` for globally unique buckets.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
public NotificationConfig.Builder setNameBytes(com.google.protobuf.ByteString value)
Required. The resource name of this NotificationConfig. Format: `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}` The `{project}` portion may be `_` for globally unique buckets.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
value
- The bytes for name to set.public String getTopic()
Required. The Pub/Sub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
string topic = 2 [(.google.api.field_behavior) = REQUIRED];
getTopic
in interface NotificationConfigOrBuilder
public com.google.protobuf.ByteString getTopicBytes()
Required. The Pub/Sub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
string topic = 2 [(.google.api.field_behavior) = REQUIRED];
getTopicBytes
in interface NotificationConfigOrBuilder
public NotificationConfig.Builder setTopic(String value)
Required. The Pub/Sub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
string topic = 2 [(.google.api.field_behavior) = REQUIRED];
value
- The topic to set.public NotificationConfig.Builder clearTopic()
Required. The Pub/Sub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
string topic = 2 [(.google.api.field_behavior) = REQUIRED];
public NotificationConfig.Builder setTopicBytes(com.google.protobuf.ByteString value)
Required. The Pub/Sub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
string topic = 2 [(.google.api.field_behavior) = REQUIRED];
value
- The bytes for topic to set.public String getEtag()
The etag of the NotificationConfig. If included in the metadata of GetNotificationConfigRequest, the operation will only be performed if the etag matches that of the NotificationConfig.
string etag = 7;
getEtag
in interface NotificationConfigOrBuilder
public com.google.protobuf.ByteString getEtagBytes()
The etag of the NotificationConfig. If included in the metadata of GetNotificationConfigRequest, the operation will only be performed if the etag matches that of the NotificationConfig.
string etag = 7;
getEtagBytes
in interface NotificationConfigOrBuilder
public NotificationConfig.Builder setEtag(String value)
The etag of the NotificationConfig. If included in the metadata of GetNotificationConfigRequest, the operation will only be performed if the etag matches that of the NotificationConfig.
string etag = 7;
value
- The etag to set.public NotificationConfig.Builder clearEtag()
The etag of the NotificationConfig. If included in the metadata of GetNotificationConfigRequest, the operation will only be performed if the etag matches that of the NotificationConfig.
string etag = 7;
public NotificationConfig.Builder setEtagBytes(com.google.protobuf.ByteString value)
The etag of the NotificationConfig. If included in the metadata of GetNotificationConfigRequest, the operation will only be performed if the etag matches that of the NotificationConfig.
string etag = 7;
value
- The bytes for etag to set.public com.google.protobuf.ProtocolStringList getEventTypesList()
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
getEventTypesList
in interface NotificationConfigOrBuilder
public int getEventTypesCount()
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
getEventTypesCount
in interface NotificationConfigOrBuilder
public String getEventTypes(int index)
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
getEventTypes
in interface NotificationConfigOrBuilder
index
- The index of the element to return.public com.google.protobuf.ByteString getEventTypesBytes(int index)
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
getEventTypesBytes
in interface NotificationConfigOrBuilder
index
- The index of the value to return.public NotificationConfig.Builder setEventTypes(int index, String value)
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
index
- The index to set the value at.value
- The eventTypes to set.public NotificationConfig.Builder addEventTypes(String value)
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
value
- The eventTypes to add.public NotificationConfig.Builder addAllEventTypes(Iterable<String> values)
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
values
- The eventTypes to add.public NotificationConfig.Builder clearEventTypes()
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
public NotificationConfig.Builder addEventTypesBytes(com.google.protobuf.ByteString value)
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
repeated string event_types = 3;
value
- The bytes of the eventTypes to add.public int getCustomAttributesCount()
NotificationConfigOrBuilder
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
getCustomAttributesCount
in interface NotificationConfigOrBuilder
public boolean containsCustomAttributes(String key)
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
containsCustomAttributes
in interface NotificationConfigOrBuilder
@Deprecated public Map<String,String> getCustomAttributes()
getCustomAttributesMap()
instead.getCustomAttributes
in interface NotificationConfigOrBuilder
public Map<String,String> getCustomAttributesMap()
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
getCustomAttributesMap
in interface NotificationConfigOrBuilder
public String getCustomAttributesOrDefault(String key, String defaultValue)
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
getCustomAttributesOrDefault
in interface NotificationConfigOrBuilder
public String getCustomAttributesOrThrow(String key)
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
getCustomAttributesOrThrow
in interface NotificationConfigOrBuilder
public NotificationConfig.Builder clearCustomAttributes()
public NotificationConfig.Builder removeCustomAttributes(String key)
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
@Deprecated public Map<String,String> getMutableCustomAttributes()
public NotificationConfig.Builder putCustomAttributes(String key, String value)
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
public NotificationConfig.Builder putAllCustomAttributes(Map<String,String> values)
A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
map<string, string> custom_attributes = 4;
public String getObjectNamePrefix()
If present, only apply this NotificationConfig to object names that begin with this prefix.
string object_name_prefix = 5;
getObjectNamePrefix
in interface NotificationConfigOrBuilder
public com.google.protobuf.ByteString getObjectNamePrefixBytes()
If present, only apply this NotificationConfig to object names that begin with this prefix.
string object_name_prefix = 5;
getObjectNamePrefixBytes
in interface NotificationConfigOrBuilder
public NotificationConfig.Builder setObjectNamePrefix(String value)
If present, only apply this NotificationConfig to object names that begin with this prefix.
string object_name_prefix = 5;
value
- The objectNamePrefix to set.public NotificationConfig.Builder clearObjectNamePrefix()
If present, only apply this NotificationConfig to object names that begin with this prefix.
string object_name_prefix = 5;
public NotificationConfig.Builder setObjectNamePrefixBytes(com.google.protobuf.ByteString value)
If present, only apply this NotificationConfig to object names that begin with this prefix.
string object_name_prefix = 5;
value
- The bytes for objectNamePrefix to set.public String getPayloadFormat()
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
getPayloadFormat
in interface NotificationConfigOrBuilder
public com.google.protobuf.ByteString getPayloadFormatBytes()
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
getPayloadFormatBytes
in interface NotificationConfigOrBuilder
public NotificationConfig.Builder setPayloadFormat(String value)
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
value
- The payloadFormat to set.public NotificationConfig.Builder clearPayloadFormat()
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
public NotificationConfig.Builder setPayloadFormatBytes(com.google.protobuf.ByteString value)
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
value
- The bytes for payloadFormat to set.public final NotificationConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
public final NotificationConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<NotificationConfig.Builder>
Copyright © 2023 Google LLC. All rights reserved.