Packages

c

com.google.pubsub.v1

PushConfig

final class PushConfig extends GeneratedMessageV3 with PushConfigOrBuilder 

Configuration for a push delivery endpoint.

Protobuf type google.pubsub.v1.PushConfig

Source
PushConfig.java
Linear Supertypes
PushConfigOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PushConfig
  2. PushConfigOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  6. def containsAttributes(key: String): Boolean 

    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.


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: Any): Boolean
    Definition Classes
    PushConfig → AbstractMessage → Message → AnyRef → Any
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. def getAttributes(): Map[String, String]

    Use #getAttributesMap() instead.

    Use #getAttributesMap() instead.

    Definition Classes
    PushConfig → PushConfigOrBuilder
  12. def getAttributesCount(): Int 

    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.


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  13. def getAttributesMap(): Map[String, String] 

    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.


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  14. def getAttributesOrDefault(key: String, defaultValue: String): String 

    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.


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  15. def getAttributesOrThrow(key: String): String 

    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.


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def getDefaultInstanceForType(): PushConfig
    Definition Classes
    PushConfig → MessageOrBuilder → MessageLiteOrBuilder
  18. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  19. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  20. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  21. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  22. def getParserForType(): Parser[PushConfig]
    Definition Classes
    PushConfig → GeneratedMessageV3 → Message → MessageLite
  23. def getPushEndpoint(): String 

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


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  24. def getPushEndpointBytes(): ByteString 

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


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  25. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  26. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  27. def getSerializedSize(): Int
    Definition Classes
    PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
  28. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    PushConfig → GeneratedMessageV3 → MessageOrBuilder
  29. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  30. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  31. def hashCode(): Int
    Definition Classes
    PushConfig → AbstractMessage → Message → AnyRef → Any
  32. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[com.google.pubsub.v1]
    Definition Classes
    PushConfig → GeneratedMessageV3
  33. def internalGetMapField(number: Int): MapField
    Attributes
    protected[com.google.pubsub.v1]
    Definition Classes
    PushConfig → GeneratedMessageV3
  34. final def isInitialized(): Boolean
    Definition Classes
    PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. def makeExtensionsImmutable(): Unit
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[com.google.pubsub.v1]
    Definition Classes
    PushConfig → GeneratedMessageV3
  39. def newBuilderForType(): Builder
    Definition Classes
    PushConfig → Message → MessageLite
  40. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  44. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  45. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  46. def toBuilder(): Builder
    Definition Classes
    PushConfig → Message → MessageLite
  47. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  48. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  49. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )
  54. def writeReplace(): AnyRef
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  55. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
  56. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from PushConfigOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped