com.google.pubsub.v1

Class PushConfig.Builder

java.lang.Object

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

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

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

com.google.pubsub.v1.PushConfig.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, PushConfigOrBuilder, java.lang.Cloneable

Enclosing class:

PushConfig

public static final class PushConfig.Builder
extends GeneratedMessage.Builder<PushConfig.Builder>
implements PushConfigOrBuilder

Protobuf type google.pubsub.v1.PushConfig

 Configuration for a push delivery endpoint.
 

Method Summary

Modifier and Type	Method and Description
PushConfig	build() Constructs the message based on the state of the Builder.
PushConfig	buildPartial() Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
PushConfig.Builder	clear() Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
PushConfig.Builder	clearPushEndpoint() A URL locating the endpoint to which messages should be pushed.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Endpoint configuration attributes.
PushConfig	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType() Get the message's type's descriptor.
java.util.Map<java.lang.String,java.lang.String>	getMutableAttributes() Endpoint configuration attributes.
java.lang.String	getPushEndpoint() A URL locating the endpoint to which messages should be pushed.
ByteString	getPushEndpointBytes() A URL locating the endpoint to which messages should be pushed.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
PushConfig.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
PushConfig.Builder	mergeFrom(Message other) Merge other into the message being built.
PushConfig.Builder	mergeFrom(PushConfig other)
PushConfig.Builder	mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into the UnknownFieldSet for this message.
PushConfig.Builder	putAllAttributes(java.util.Map<java.lang.String,java.lang.String> values) Endpoint configuration attributes.
PushConfig.Builder	setPushEndpoint(java.lang.String value) A URL locating the endpoint to which messages should be pushed.
PushConfig.Builder	setPushEndpointBytes(ByteString value) A URL locating the endpoint to which messages should be pushed.
PushConfig.Builder	setUnknownFields(UnknownFieldSet unknownFields) Set the UnknownFieldSet for this message.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField, setField, setRepeatedField

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

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

Methods inherited from class java.lang.Object

equals, 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

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

clear

public PushConfig.Builder clear()

Description copied from class: GeneratedMessage.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessage.Builder<PushConfig.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage.Builder<PushConfig.Builder>

getDefaultInstanceForType

public PushConfig getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public PushConfig build()

Description copied from interface: MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public PushConfig buildPartial()

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

mergeFrom

public PushConfig.Builder mergeFrom(Message other)

Description copied from interface: Message.Builder

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
* For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other are concatenated with the elements in this message. * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved. This is equivalent to the Message::MergeFrom method in C++.

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PushConfig.Builder>

mergeFrom

public PushConfig.Builder mergeFrom(PushConfig other)

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.Builder<PushConfig.Builder>

mergeFrom

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

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class 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".
 

Specified by:

getPushEndpoint in interface PushConfigOrBuilder

getPushEndpointBytes

public ByteString getPushEndpointBytes()

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

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

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

setPushEndpointBytes

public PushConfig.Builder setPushEndpointBytes(ByteString value)

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

getAttributes

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

 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.
 

Specified by:

getAttributes in interface PushConfigOrBuilder

getMutableAttributes

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

 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.
 

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.
 

setUnknownFields

public final PushConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Set the UnknownFieldSet for this message.

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessage.Builder<PushConfig.Builder>

mergeUnknownFields

public final PushConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessage.Builder<PushConfig.Builder>