Interface NotificationOrBuilder (2.18.0)

public interface NotificationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCustomAttributes(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
boolean

getCustomAttributes()

public abstract Map<String,String> getCustomAttributes()
Returns
TypeDescription
Map<String,String>

getCustomAttributesCount()

public abstract 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
TypeDescription
int

getCustomAttributesMap()

public abstract 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
TypeDescription
Map<String,String>

getCustomAttributesOrDefault(String key, String defaultValue)

public abstract 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getCustomAttributesOrThrow(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
String

getEtag()

public abstract 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
TypeDescription
String

The etag.

getEtagBytes()

public abstract 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
TypeDescription
ByteString

The bytes for etag.

getEventTypes(int index)

public abstract 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The eventTypes at the given index.

getEventTypesBytes(int index)

public abstract 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the eventTypes at the given index.

getEventTypesCount()

public abstract 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
TypeDescription
int

The count of eventTypes.

getEventTypesList()

public abstract List<String> getEventTypesList()

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

repeated string event_types = 3;

Returns
TypeDescription
List<String>

A list containing the eventTypes.

getName()

public abstract 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
TypeDescription
String

The name.

getNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for name.

getObjectNamePrefix()

public abstract String getObjectNamePrefix()

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

string object_name_prefix = 5;

Returns
TypeDescription
String

The objectNamePrefix.

getObjectNamePrefixBytes()

public abstract ByteString getObjectNamePrefixBytes()

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

string object_name_prefix = 5;

Returns
TypeDescription
ByteString

The bytes for objectNamePrefix.

getPayloadFormat()

public abstract String getPayloadFormat()

Required. The desired content of the Payload.

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

Returns
TypeDescription
String

The payloadFormat.

getPayloadFormatBytes()

public abstract ByteString getPayloadFormatBytes()

Required. The desired content of the Payload.

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

Returns
TypeDescription
ByteString

The bytes for payloadFormat.

getTopic()

public abstract 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
TypeDescription
String

The topic.

getTopicBytes()

public abstract 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
TypeDescription
ByteString

The bytes for topic.