com.google.storage.v2

Class Notification

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.storage.v2.Notification

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NotificationOrBuilder, Serializable

public final class Notification
extends com.google.protobuf.GeneratedMessageV3
implements NotificationOrBuilder

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

Protobuf type google.storage.v2.Notification

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.Builder A directive to publish Pub/Sub notifications upon changes to a bucket.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CUSTOM_ATTRIBUTES_FIELD_NUMBER
static int	ETAG_FIELD_NUMBER
static int	EVENT_TYPES_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	OBJECT_NAME_PREFIX_FIELD_NUMBER
static int	PAYLOAD_FORMAT_FIELD_NUMBER
static int	TOPIC_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsCustomAttributes(String key) A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.
boolean	equals(Object obj)
Map<String,String>	getCustomAttributes() Deprecated.
int	getCustomAttributesCount() A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.
Map<String,String>	getCustomAttributesMap() A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.
String	getCustomAttributesOrDefault(String key, String defaultValue) A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.
String	getCustomAttributesOrThrow(String key) A list of additional attributes to attach to each Pub/Sub message published for this notification subscription.
static Notification	getDefaultInstance()
Notification	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEtag() The etag of the Notification.
com.google.protobuf.ByteString	getEtagBytes() The etag of the Notification.
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.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getObjectNamePrefix() If present, only apply this notification config to object names that begin with this prefix.
com.google.protobuf.ByteString	getObjectNamePrefixBytes() If present, only apply this notification config to object names that begin with this prefix.
com.google.protobuf.Parser<Notification>	getParserForType()
String	getPayloadFormat() Required.
com.google.protobuf.ByteString	getPayloadFormatBytes() Required.
int	getSerializedSize()
String	getTopic() Required.
com.google.protobuf.ByteString	getTopicBytes() Required.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Notification.Builder	newBuilder()
static Notification.Builder	newBuilder(Notification prototype)
Notification.Builder	newBuilderForType()
protected Notification.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Notification	parseDelimitedFrom(InputStream input)
static Notification	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Notification	parseFrom(byte[] data)
static Notification	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Notification	parseFrom(ByteBuffer data)
static Notification	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Notification	parseFrom(com.google.protobuf.ByteString data)
static Notification	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Notification	parseFrom(com.google.protobuf.CodedInputStream input)
static Notification	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Notification	parseFrom(InputStream input)
static Notification	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Notification>	parser()
Notification.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TOPIC_FIELD_NUMBER

public static final int TOPIC_FIELD_NUMBER

See Also:

Constant Field Values

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

See Also:

Constant Field Values

EVENT_TYPES_FIELD_NUMBER

public static final int EVENT_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_ATTRIBUTES_FIELD_NUMBER

public static final int CUSTOM_ATTRIBUTES_FIELD_NUMBER

See Also:

Constant Field Values

OBJECT_NAME_PREFIX_FIELD_NUMBER

public static final int OBJECT_NAME_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

PAYLOAD_FORMAT_FIELD_NUMBER

public static final int PAYLOAD_FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

Specified by:

getName in interface NotificationOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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];

Specified by:

getNameBytes in interface NotificationOrBuilder

Returns:

The bytes for name.

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

Specified by:

getTopic in interface NotificationOrBuilder

Returns:

The topic.

getTopicBytes

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

Specified by:

getTopicBytes in interface NotificationOrBuilder

Returns:

The bytes for topic.

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;

Specified by:

getEtag in interface NotificationOrBuilder

Returns:

The etag.

getEtagBytes

public com.google.protobuf.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;

Specified by:

getEtagBytes in interface NotificationOrBuilder

Returns:

The bytes for etag.

getEventTypesList

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;

Specified by:

getEventTypesList in interface NotificationOrBuilder

Returns:

A list containing the eventTypes.

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;

Specified by:

getEventTypesCount in interface NotificationOrBuilder

Returns:

The count of eventTypes.

getEventTypes

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;

Specified by:

getEventTypes in interface NotificationOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The eventTypes at the given index.

getEventTypesBytes

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;

Specified by:

getEventTypesBytes in interface NotificationOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the eventTypes at the given index.

getCustomAttributesCount

public int getCustomAttributesCount()

Description copied from interface: NotificationOrBuilder

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

map<string, string> custom_attributes = 4;

Specified by:

getCustomAttributesCount in interface NotificationOrBuilder

containsCustomAttributes

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;

Specified by:

containsCustomAttributes in interface NotificationOrBuilder

getCustomAttributes

@Deprecated
public Map<String,String> getCustomAttributes()

Deprecated.

Use getCustomAttributesMap() instead.

Specified by:

getCustomAttributes in interface NotificationOrBuilder

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;

Specified by:

getCustomAttributesMap in interface NotificationOrBuilder

getCustomAttributesOrDefault

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;

Specified by:

getCustomAttributesOrDefault in interface NotificationOrBuilder

getCustomAttributesOrThrow

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;

Specified by:

getCustomAttributesOrThrow in interface NotificationOrBuilder

getObjectNamePrefix

public String getObjectNamePrefix()

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

string object_name_prefix = 5;

Specified by:

getObjectNamePrefix in interface NotificationOrBuilder

Returns:

The objectNamePrefix.

getObjectNamePrefixBytes

public com.google.protobuf.ByteString getObjectNamePrefixBytes()

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

string object_name_prefix = 5;

Specified by:

getObjectNamePrefixBytes in interface NotificationOrBuilder

Returns:

The bytes for objectNamePrefix.

getPayloadFormat

public String getPayloadFormat()

 Required. The desired content of the Payload.
 

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

Specified by:

getPayloadFormat in interface NotificationOrBuilder

Returns:

The payloadFormat.

getPayloadFormatBytes

public com.google.protobuf.ByteString getPayloadFormatBytes()

 Required. The desired content of the Payload.
 

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

Specified by:

getPayloadFormatBytes in interface NotificationOrBuilder

Returns:

The bytes for payloadFormat.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Notification parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Notification parseFrom(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Notification parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Notification parseFrom(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Notification parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Notification parseFrom(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Notification parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static Notification parseFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Notification parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Notification parseDelimitedFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static Notification parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static Notification parseFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public Notification.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Notification.Builder newBuilder()

newBuilder

public static Notification.Builder newBuilder(Notification prototype)

toBuilder

public Notification.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Notification.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Notification getDefaultInstance()

parser

public static com.google.protobuf.Parser<Notification> parser()

getParserForType

public com.google.protobuf.Parser<Notification> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Notification getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder