Class Notification.Builder (2.18.0)

public static final class Notification.Builder extends GeneratedMessageV3.Builder<Notification.Builder> implements NotificationOrBuilder

A directive to publish Pub/Sub notifications upon changes to a bucket.

Protobuf type google.storage.v2.Notification

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Notification.Builder

Implements

NotificationOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

Methods

addAllEventTypes(Iterable<String> values)

public Notification.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;

Parameter

Name	Description
`values`	`Iterable<String>` The eventTypes to add.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

addEventTypes(String value)

public Notification.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;

Parameter

Name	Description
`value`	`String` The eventTypes to add.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

addEventTypesBytes(ByteString value)

public Notification.Builder addEventTypesBytes(ByteString value)

If present, only send notifications about listed event types. If empty, sent notifications for all event types.

repeated string event_types = 3;

Parameter

Name	Description
`value`	`ByteString` The bytes of the eventTypes to add.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Notification.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Notification build()

Returns

Type	Description
`Notification`

buildPartial()

public Notification buildPartial()

Returns

Type	Description
`Notification`

clear()

public Notification.Builder clear()

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCustomAttributes()

public Notification.Builder clearCustomAttributes()

Returns

Type	Description
`Notification.Builder`

clearEtag()

public Notification.Builder clearEtag()

The etag of the Notification. If included in the metadata of GetNotificationRequest, the operation will only be performed if the etag matches that of the Notification.

string etag = 7;

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

clearEventTypes()

public Notification.Builder clearEventTypes()

If present, only send notifications about listed event types. If empty, sent notifications for all event types.

repeated string event_types = 3;

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Notification.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public Notification.Builder clearName()

Required. The resource name of this notification. Format: projects/{project}/buckets/{bucket}/notificationConfigs/{notification} The {project} portion may be _ for globally unique buckets.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

clearObjectNamePrefix()

public Notification.Builder clearObjectNamePrefix()

If present, only apply this notification config to object names that begin with this prefix.

string object_name_prefix = 5;

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Notification.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
`oneof`	`OneofDescriptor`

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPayloadFormat()

public Notification.Builder clearPayloadFormat()

Required. The desired content of the Payload.

string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

clearTopic()

public Notification.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];

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

clone()

public Notification.Builder clone()

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsCustomAttributes(String key)

public boolean containsCustomAttributes(String key)

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

getCustomAttributes()

public Map<String,String> getCustomAttributes()

Use #getCustomAttributesMap() instead.

Returns

Type	Description
`Map<String,String>`

getCustomAttributesCount()

public int getCustomAttributesCount()

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Returns

Type	Description
`int`

getCustomAttributesMap()

public Map<String,String> getCustomAttributesMap()

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Returns

Type	Description
`Map<String,String>`

getCustomAttributesOrDefault(String key, String defaultValue)

public String getCustomAttributesOrDefault(String key, String defaultValue)

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getCustomAttributesOrThrow(String key)

public String getCustomAttributesOrThrow(String key)

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getDefaultInstanceForType()

public Notification getDefaultInstanceForType()

Returns

Type	Description
`Notification`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEtag()

public String getEtag()

The etag of the Notification. If included in the metadata of GetNotificationRequest, the operation will only be performed if the etag matches that of the Notification.

string etag = 7;

Returns

Type	Description
`String`	The etag.

getEtagBytes()

public ByteString getEtagBytes()

The etag of the Notification. If included in the metadata of GetNotificationRequest, the operation will only be performed if the etag matches that of the Notification.

string etag = 7;

Returns

Type	Description
`ByteString`	The bytes for etag.

getEventTypes(int index)

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;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The eventTypes at the given index.

getEventTypesBytes(int index)

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

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the eventTypes at the given index.

getEventTypesCount()

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;

Returns

Type	Description
`int`	The count of eventTypes.

getEventTypesList()

public ProtocolStringList getEventTypesList()

If present, only send notifications about listed event types. If empty, sent notifications for all event types.

repeated string event_types = 3;

Returns

Type	Description
`ProtocolStringList`	A list containing the eventTypes.

getMutableCustomAttributes()

public Map<String,String> getMutableCustomAttributes()

Use alternate mutation accessors instead.

Returns

Type	Description
`Map<String,String>`

getName()

public String getName()

Required. The resource name of this notification. Format: projects/{project}/buckets/{bucket}/notificationConfigs/{notification} The {project} portion may be _ for globally unique buckets.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of this notification. Format: projects/{project}/buckets/{bucket}/notificationConfigs/{notification} The {project} portion may be _ for globally unique buckets.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`ByteString`	The bytes for name.

getObjectNamePrefix()

public String getObjectNamePrefix()

If present, only apply this notification config to object names that begin with this prefix.

string object_name_prefix = 5;

Returns

Type	Description
`String`	The objectNamePrefix.

getObjectNamePrefixBytes()

public ByteString getObjectNamePrefixBytes()

If present, only apply this notification config to object names that begin with this prefix.

string object_name_prefix = 5;

Returns

Type	Description
`ByteString`	The bytes for objectNamePrefix.

getPayloadFormat()

public String getPayloadFormat()

Required. The desired content of the Payload.

string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`String`	The payloadFormat.

getPayloadFormatBytes()

public ByteString getPayloadFormatBytes()

Required. The desired content of the Payload.

string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`ByteString`	The bytes for payloadFormat.

getTopic()

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

Returns

Type	Description
`String`	The topic.

getTopicBytes()

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

Returns

Type	Description
`ByteString`	The bytes for topic.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Notification.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Notification.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
`IOException`

mergeFrom(Message other)

public Notification.Builder mergeFrom(Message other)

Parameter

Name	Description
`other`	`Message`

Returns

Type	Description
`Notification.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(Notification other)

public Notification.Builder mergeFrom(Notification other)

Parameter

Name	Description
`other`	`Notification`

Returns

Type	Description
`Notification.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Notification.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllCustomAttributes(Map<String,String> values)

public Notification.Builder putAllCustomAttributes(Map<String,String> values)

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Parameter

Name	Description
`values`	`Map<String,String>`

Returns

Type	Description
`Notification.Builder`

putCustomAttributes(String key, String value)

public Notification.Builder putCustomAttributes(String key, String value)

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Parameters

Name	Description
`key`	`String`
`value`	`String`

Returns

Type	Description
`Notification.Builder`

removeCustomAttributes(String key)

public Notification.Builder removeCustomAttributes(String key)

A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.

map<string, string> custom_attributes = 4;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`Notification.Builder`

setEtag(String value)

public Notification.Builder setEtag(String value)

The etag of the Notification. If included in the metadata of GetNotificationRequest, the operation will only be performed if the etag matches that of the Notification.

string etag = 7;

Parameter

Name	Description
`value`	`String` The etag to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setEtagBytes(ByteString value)

public Notification.Builder setEtagBytes(ByteString value)

The etag of the Notification. If included in the metadata of GetNotificationRequest, the operation will only be performed if the etag matches that of the Notification.

string etag = 7;

Parameter

Name	Description
`value`	`ByteString` The bytes for etag to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setEventTypes(int index, String value)

public Notification.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;

Parameters

Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The eventTypes to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Notification.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Notification.Builder setName(String value)

Required. The resource name of this notification. Format: projects/{project}/buckets/{bucket}/notificationConfigs/{notification} The {project} portion may be _ for globally unique buckets.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`String` The name to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Notification.Builder setNameBytes(ByteString value)

Required. The resource name of this notification. Format: projects/{project}/buckets/{bucket}/notificationConfigs/{notification} The {project} portion may be _ for globally unique buckets.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`ByteString` The bytes for name to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setObjectNamePrefix(String value)

public Notification.Builder setObjectNamePrefix(String value)

If present, only apply this notification config to object names that begin with this prefix.

string object_name_prefix = 5;

Parameter

Name	Description
`value`	`String` The objectNamePrefix to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setObjectNamePrefixBytes(ByteString value)

public Notification.Builder setObjectNamePrefixBytes(ByteString value)

If present, only apply this notification config to object names that begin with this prefix.

string object_name_prefix = 5;

Parameter

Name	Description
`value`	`ByteString` The bytes for objectNamePrefix to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setPayloadFormat(String value)

public Notification.Builder setPayloadFormat(String value)

Required. The desired content of the Payload.

string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`String` The payloadFormat to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setPayloadFormatBytes(ByteString value)

public Notification.Builder setPayloadFormatBytes(ByteString value)

Required. The desired content of the Payload.

string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`ByteString` The bytes for payloadFormat to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Notification.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTopic(String value)

public Notification.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];

Parameter

Name	Description
`value`	`String` The topic to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setTopicBytes(ByteString value)

public Notification.Builder setTopicBytes(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];

Parameter

Name	Description
`value`	`ByteString` The bytes for topic to set.

Returns

Type	Description
`Notification.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Notification.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`Notification.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)