com.google.pubsub.v1

Class PushConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.pubsub.v1.PushConfig

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, PushConfigOrBuilder, java.io.Serializable

public final class PushConfig
extends GeneratedMessage
implements PushConfigOrBuilder

Protobuf type google.pubsub.v1.PushConfig

 Configuration for a push delivery endpoint.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PushConfig.Builder Protobuf type google.pubsub.v1.PushConfig

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTES_FIELD_NUMBER
static int	PUSH_ENDPOINT_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Endpoint configuration attributes.
static PushConfig	getDefaultInstance()
PushConfig	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Parser<PushConfig>	getParserForType() Gets the parser for a message of the same type as this message.
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.
int	getSerializedSize() Get the number of bytes required to encode this message.
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static PushConfig.Builder	newBuilder()
static PushConfig.Builder	newBuilder(PushConfig prototype)
PushConfig.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
static PushConfig	parseDelimitedFrom(java.io.InputStream input)
static PushConfig	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static PushConfig	parseFrom(byte[] data)
static PushConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static PushConfig	parseFrom(ByteString data)
static PushConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static PushConfig	parseFrom(CodedInputStream input)
static PushConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static PushConfig	parseFrom(java.io.InputStream input)
static PushConfig	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<PushConfig>	parser()
PushConfig.Builder	toBuilder() Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashCode, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PUSH_ENDPOINT_FIELD_NUMBER

public static final int PUSH_ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessage

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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

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

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

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

parseFrom

public static PushConfig parseFrom(ByteString data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PushConfig parseFrom(ByteString data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PushConfig parseFrom(byte[] data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PushConfig parseFrom(byte[] data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PushConfig parseFrom(java.io.InputStream input)
                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PushConfig parseFrom(java.io.InputStream input,
                                   ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PushConfig parseDelimitedFrom(java.io.InputStream input)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PushConfig parseDelimitedFrom(java.io.InputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PushConfig parseFrom(CodedInputStream input)
                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PushConfig parseFrom(CodedInputStream input,
                                   ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public PushConfig.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static PushConfig.Builder newBuilder()

newBuilder

public static PushConfig.Builder newBuilder(PushConfig prototype)

toBuilder

public PushConfig.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

getDefaultInstance

public static PushConfig getDefaultInstance()

parser

public static Parser<PushConfig> parser()

getParserForType

public Parser<PushConfig> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

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