com.google.pubsub.v1

Class PushConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

com.google.pubsub.v1.PushConfig.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PushConfigOrBuilder, java.lang.Cloneable

Enclosing class:

PushConfig

public static final class PushConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>
implements PushConfigOrBuilder

 Configuration for a push delivery endpoint.
 

Protobuf type google.pubsub.v1.PushConfig

Method Summary

Modifier and Type	Method and Description
PushConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
PushConfig	build()
PushConfig	buildPartial()
PushConfig.Builder	clear()
PushConfig.Builder	clearAttributes()
PushConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
PushConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
PushConfig.Builder	clearPushEndpoint() A URL locating the endpoint to which messages should be pushed.
PushConfig.Builder	clone()
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.
PushConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
java.util.Map<java.lang.String,java.lang.String>	getMutableAttributes() Deprecated.
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
PushConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PushConfig.Builder	mergeFrom(com.google.protobuf.Message other)
PushConfig.Builder	mergeFrom(PushConfig other)
PushConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
PushConfig.Builder	putAllAttributes(java.util.Map<java.lang.String,java.lang.String> values) Endpoint configuration attributes.
PushConfig.Builder	putAttributes(java.lang.String key, java.lang.String value) Endpoint configuration attributes.
PushConfig.Builder	removeAttributes(java.lang.String key) Endpoint configuration attributes.
PushConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
PushConfig.Builder	setPushEndpoint(java.lang.String value) A URL locating the endpoint to which messages should be pushed.
PushConfig.Builder	setPushEndpointBytes(com.google.protobuf.ByteString value) A URL locating the endpoint to which messages should be pushed.
PushConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
PushConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

clear

public PushConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

getDefaultInstanceForType

public PushConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public PushConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public PushConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public PushConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

setField

public PushConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   java.lang.Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

clearField

public PushConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

clearOneof

public PushConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

setRepeatedField

public PushConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           java.lang.Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

addRepeatedField

public PushConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           java.lang.Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

mergeFrom

public PushConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PushConfig.Builder>

mergeFrom

public PushConfig.Builder mergeFrom(PushConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

mergeFrom

public PushConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PushConfig.Builder>

Throws:

java.io.IOException

getPushEndpoint

public 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".
 

optional string push_endpoint = 1;

Specified by:

getPushEndpoint in interface PushConfigOrBuilder

getPushEndpointBytes

public 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".
 

optional string push_endpoint = 1;

Specified by:

getPushEndpointBytes in interface PushConfigOrBuilder

setPushEndpoint

public PushConfig.Builder setPushEndpoint(java.lang.String value)

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

optional string push_endpoint = 1;

clearPushEndpoint

public PushConfig.Builder clearPushEndpoint()

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

optional string push_endpoint = 1;

setPushEndpointBytes

public PushConfig.Builder setPushEndpointBytes(com.google.protobuf.ByteString value)

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

optional string push_endpoint = 1;

getAttributesCount

public int getAttributesCount()

Description copied from interface: PushConfigOrBuilder

 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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

Specified by:

getAttributesCount in interface PushConfigOrBuilder

containsAttributes

public 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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

Specified by:

containsAttributes in interface PushConfigOrBuilder

getAttributes

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

Deprecated.

Use getAttributesMap() instead.

Specified by:

getAttributes in interface PushConfigOrBuilder

getAttributesMap

public 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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

Specified by:

getAttributesMap in interface PushConfigOrBuilder

getAttributesOrDefault

public 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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

Specified by:

getAttributesOrDefault in interface PushConfigOrBuilder

getAttributesOrThrow

public 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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

Specified by:

getAttributesOrThrow in interface PushConfigOrBuilder

clearAttributes

public PushConfig.Builder clearAttributes()

removeAttributes

public PushConfig.Builder removeAttributes(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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

getMutableAttributes

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

Deprecated.

Use alternate mutation accessors instead.

putAttributes

public PushConfig.Builder putAttributes(java.lang.String key,
                                        java.lang.String value)

 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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

putAllAttributes

public PushConfig.Builder putAllAttributes(java.util.Map<java.lang.String,java.lang.String> values)

 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 push message. This attribute
 indicates the version of the data expected by the endpoint. This
 controls the shape of the envelope (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;

setUnknownFields

public final PushConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

mergeUnknownFields

public final PushConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>