Interface NotificationOrBuilder (2.9.0)

Version 2.9.0

• 2.45.0 (latest)
• 2.44.1
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public interface NotificationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCustomAttributes(String key)

public abstract boolean containsCustomAttributes(String key)

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

map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getCustomAttributes()

public abstract Map<String,String> getCustomAttributes()

Use #getCustomAttributesMap() instead.

Returns

Type	Description
Map<String,String>

getCustomAttributesCount()

public abstract int getCustomAttributesCount()

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

map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int

getCustomAttributesMap()

public abstract Map<String,String> getCustomAttributesMap()

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

map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Map<String,String>

getCustomAttributesOrDefault(String key, String defaultValue)

public abstract String getCustomAttributesOrDefault(String key, String defaultValue)

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

map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getCustomAttributesOrThrow(String key)

public abstract String getCustomAttributesOrThrow(String key)

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

map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
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

Type	Description
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

Type	Description
ByteString	The bytes for etag.

getEventTypes(int index)

public abstract String getEventTypes(int index)

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

repeated string event_types = 3 [(.google.api.field_behavior) = OPTIONAL];

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 abstract ByteString getEventTypesBytes(int index)

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

repeated string event_types = 3 [(.google.api.field_behavior) = OPTIONAL];

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 abstract int getEventTypesCount()

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

repeated string event_types = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The count of eventTypes.

getEventTypesList()

public abstract List<String> getEventTypesList()

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

repeated string event_types = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
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

Type	Description
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

Type	Description
ByteString	The bytes for name.

getObjectNamePrefix()

public abstract String getObjectNamePrefix()

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

string object_name_prefix = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The objectNamePrefix.

getObjectNamePrefixBytes()

public abstract ByteString getObjectNamePrefixBytes()

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

string object_name_prefix = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
ByteString	The bytes for topic.