public final class NotificationConfig extends GeneratedMessageV3 implements NotificationConfigOrBuilder
A directive to publish Pub/Sub notifications upon changes to a bucket.
Protobuf type google.storage.v2.NotificationConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CUSTOM_ATTRIBUTES_FIELD_NUMBER
public static final int CUSTOM_ATTRIBUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EVENT_TYPES_FIELD_NUMBER
public static final int EVENT_TYPES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OBJECT_NAME_PREFIX_FIELD_NUMBER
public static final int OBJECT_NAME_PREFIX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PAYLOAD_FORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOPIC_FIELD_NUMBER
public static final int TOPIC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static NotificationConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static NotificationConfig.Builder newBuilder()
newBuilder(NotificationConfig prototype)
public static NotificationConfig.Builder newBuilder(NotificationConfig prototype)
public static NotificationConfig parseDelimitedFrom(InputStream input)
public static NotificationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static NotificationConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NotificationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static NotificationConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NotificationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NotificationConfig parseFrom(CodedInputStream input)
public static NotificationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NotificationConfig parseFrom(InputStream input)
public static NotificationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static NotificationConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NotificationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<NotificationConfig> parser()
Methods
containsCustomAttributes(String key)
public boolean containsCustomAttributes(String key)
Optional. A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCustomAttributes() (deprecated)
public Map<String,String> getCustomAttributes()
getCustomAttributesCount()
public int getCustomAttributesCount()
Optional. A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getCustomAttributesMap()
public Map<String,String> getCustomAttributesMap()
Optional. A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];
getCustomAttributesOrDefault(String key, String defaultValue)
public String getCustomAttributesOrDefault(String key, String defaultValue)
Optional. A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getCustomAttributesOrThrow(String key)
public String getCustomAttributesOrThrow(String key)
Optional. A list of additional attributes to attach to each Pub/Sub
message published for this NotificationConfig.
map<string, string> custom_attributes = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getDefaultInstanceForType()
public NotificationConfig getDefaultInstanceForType()
getEtag()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
getEventTypes(int index)
public 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 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 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 ProtocolStringList 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];
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 |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getObjectNamePrefix()
public String getObjectNamePrefix()
Optional. If present, only apply this NotificationConfig 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 ByteString getObjectNamePrefixBytes()
Optional. If present, only apply this NotificationConfig 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.
|
getParserForType()
public Parser<NotificationConfig> getParserForType()
Overrides
public String getPayloadFormat()
Required. The desired content of the Payload.
string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The payloadFormat.
|
public 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public NotificationConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NotificationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public NotificationConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
