public final class Notification extends GeneratedMessageV3 implements NotificationOrBuilder
A directive to publish Pub/Sub notifications upon changes to a bucket.
Protobuf type google.storage.v2.Notification
Static Fields
CUSTOM_ATTRIBUTES_FIELD_NUMBER
public static final int CUSTOM_ATTRIBUTES_FIELD_NUMBER
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
EVENT_TYPES_FIELD_NUMBER
public static final int EVENT_TYPES_FIELD_NUMBER
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
OBJECT_NAME_PREFIX_FIELD_NUMBER
public static final int OBJECT_NAME_PREFIX_FIELD_NUMBER
public static final int PAYLOAD_FORMAT_FIELD_NUMBER
TOPIC_FIELD_NUMBER
public static final int TOPIC_FIELD_NUMBER
Static Methods
getDefaultInstance()
public static Notification getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Notification.Builder newBuilder()
newBuilder(Notification )
public static Notification.Builder newBuilder(Notification )
public static Notification parseDelimitedFrom(InputStream input)
public static Notification parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Notification parseFrom(byte[] data)
| Name | Description |
| data | byte[]
|
ReturnsExceptionsparseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Notification parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Notification parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Notification parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Notification parseFrom(CodedInputStream input)
public static Notification parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Notification parseFrom(InputStream input)
public static Notification parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Notification parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Notification parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Notification> parser()
Methods
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;
equals(Object obj)
public boolean equals(Object obj)
getCustomAttributes()
public Map<String,String> getCustomAttributes()
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;
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;
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;
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;
getDefaultInstanceForType()
public Notification getDefaultInstanceForType()
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;
| 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;
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;
| 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;
| 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;
| 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;
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];
| 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];
getObjectNamePrefix()
public String getObjectNamePrefix()
If present, only apply this notification config to object names that begin with this prefix.
string object_name_prefix = 5;
| 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;
| Type | Description |
| ByteString | The bytes for objectNamePrefix. |
getParserForType()
public Parser<Notification> getParserForType()
public String getPayloadFormat()
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The payloadFormat. |
public ByteString getPayloadFormatBytes()
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for payloadFormat. |
getSerializedSize()
public int getSerializedSize()
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];
| 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
hashCode()
ReturnsOverridesinternalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
isInitialized()
public final boolean isInitialized()
newBuilderForType()
public Notification.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Notification.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
toBuilder()
public Notification.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)