NotificationConfigOrBuilder (Storage Parent 2.24.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

NotificationConfig, NotificationConfig.Builder
```
public interface NotificationConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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 NotificationConfig.
`Map<String,String>`	`getCustomAttributes()` Deprecated.
`int`	`getCustomAttributesCount()` A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
`Map<String,String>`	`getCustomAttributesMap()` A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
`String`	`getCustomAttributesOrDefault(String key, String defaultValue)` A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
`String`	`getCustomAttributesOrThrow(String key)` A list of additional attributes to attach to each Pub/Sub message published for this NotificationConfig.
`String`	`getEtag()` The etag of the NotificationConfig.
`com.google.protobuf.ByteString`	`getEtagBytes()` The etag of the NotificationConfig.
`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.
`List<String>`	`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 NotificationConfig to object names that begin with this prefix.
`com.google.protobuf.ByteString`	`getObjectNamePrefixBytes()` If present, only apply this NotificationConfig to object names that begin with this prefix.
`String`	`getPayloadFormat()` Required.
`com.google.protobuf.ByteString`	`getPayloadFormatBytes()` Required.
`String`	`getTopic()` Required.
`com.google.protobuf.ByteString`	`getTopicBytes()` Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

String getName()

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

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

Returns:: The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

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

Returns:: The bytes for name.

getTopic

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:: The topic.

getTopicBytes

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

Returns:: The bytes for topic.

getEtag

String getEtag()

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

string etag = 7;

Returns:: The etag.

getEtagBytes

com.google.protobuf.ByteString getEtagBytes()

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

string etag = 7;

Returns:: The bytes for etag.

getEventTypesList

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:: A list containing the eventTypes.

getEventTypesCount

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:: The count of eventTypes.

getEventTypes

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;

Parameters:: index - The index of the element to return.
Returns:: The eventTypes at the given index.

getEventTypesBytes

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;

Parameters:: index - The index of the value to return.
Returns:: The bytes of the eventTypes at the given index.