com.google.pubsub.v1

Interface PushConfigOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

PushConfig, PushConfig.Builder

public interface PushConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAttributes(java.lang.String key) Endpoint configuration attributes.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Deprecated.
int	getAttributesCount() Endpoint configuration attributes.
java.util.Map<java.lang.String,java.lang.String>	getAttributesMap() Endpoint configuration attributes.
java.lang.String	getAttributesOrDefault(java.lang.String key, java.lang.String defaultValue) Endpoint configuration attributes.
java.lang.String	getAttributesOrThrow(java.lang.String key) Endpoint configuration attributes.
java.lang.String	getPushEndpoint() A URL locating the endpoint to which messages should be pushed.
com.google.protobuf.ByteString	getPushEndpointBytes() A URL locating the endpoint to which messages should be pushed.

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

getPushEndpoint

java.lang.String getPushEndpoint()

 A URL locating the endpoint to which messages should be pushed.
 For example, a Webhook endpoint might use "https://example.com/push".
 

string push_endpoint = 1;

getPushEndpointBytes

com.google.protobuf.ByteString getPushEndpointBytes()

 A URL locating the endpoint to which messages should be pushed.
 For example, a Webhook endpoint might use "https://example.com/push".
 

string push_endpoint = 1;

getAttributesCount

int getAttributesCount()

 Endpoint configuration attributes.
 Every endpoint has a set of API supported attributes that can be used to
 control different aspects of the message delivery.
 The currently supported attribute is `x-goog-version`, which you can
 use to change the format of the pushed message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the pushed message (i.e., its fields and metadata).
 The endpoint version is based on the version of the Pub/Sub API.
 If not present during the `CreateSubscription` call, it will default to
 the version of the API used to make such call. If not present during a
 `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
 calls will always return a valid version, even if the subscription was
 created without this attribute.
 The possible values for this attribute are:
 * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
 * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
 

map<string, string> attributes = 2;

containsAttributes

boolean containsAttributes(java.lang.String key)

 Endpoint configuration attributes.
 Every endpoint has a set of API supported attributes that can be used to
 control different aspects of the message delivery.
 The currently supported attribute is `x-goog-version`, which you can
 use to change the format of the pushed message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the pushed message (i.e., its fields and metadata).
 The endpoint version is based on the version of the Pub/Sub API.
 If not present during the `CreateSubscription` call, it will default to
 the version of the API used to make such call. If not present during a
 `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
 calls will always return a valid version, even if the subscription was
 created without this attribute.
 The possible values for this attribute are:
 * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
 * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
 

map<string, string> attributes = 2;

getAttributes

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getAttributes()

Deprecated.

Use getAttributesMap() instead.

getAttributesMap

java.util.Map<java.lang.String,java.lang.String> getAttributesMap()

 Endpoint configuration attributes.
 Every endpoint has a set of API supported attributes that can be used to
 control different aspects of the message delivery.
 The currently supported attribute is `x-goog-version`, which you can
 use to change the format of the pushed message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the pushed message (i.e., its fields and metadata).
 The endpoint version is based on the version of the Pub/Sub API.
 If not present during the `CreateSubscription` call, it will default to
 the version of the API used to make such call. If not present during a
 `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
 calls will always return a valid version, even if the subscription was
 created without this attribute.
 The possible values for this attribute are:
 * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
 * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
 

map<string, string> attributes = 2;

getAttributesOrDefault

java.lang.String getAttributesOrDefault(java.lang.String key,
                                        java.lang.String defaultValue)

 Endpoint configuration attributes.
 Every endpoint has a set of API supported attributes that can be used to
 control different aspects of the message delivery.
 The currently supported attribute is `x-goog-version`, which you can
 use to change the format of the pushed message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the pushed message (i.e., its fields and metadata).
 The endpoint version is based on the version of the Pub/Sub API.
 If not present during the `CreateSubscription` call, it will default to
 the version of the API used to make such call. If not present during a
 `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
 calls will always return a valid version, even if the subscription was
 created without this attribute.
 The possible values for this attribute are:
 * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
 * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
 

map<string, string> attributes = 2;

getAttributesOrThrow

java.lang.String getAttributesOrThrow(java.lang.String key)

 Endpoint configuration attributes.
 Every endpoint has a set of API supported attributes that can be used to
 control different aspects of the message delivery.
 The currently supported attribute is `x-goog-version`, which you can
 use to change the format of the pushed message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the pushed message (i.e., its fields and metadata).
 The endpoint version is based on the version of the Pub/Sub API.
 If not present during the `CreateSubscription` call, it will default to
 the version of the API used to make such call. If not present during a
 `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
 calls will always return a valid version, even if the subscription was
 created without this attribute.
 The possible values for this attribute are:
 * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
 * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
 

map<string, string> attributes = 2;