Packages

t

com.google.pubsub.v1

PushConfigOrBuilder

trait PushConfigOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PushConfigOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def containsAttributes(key: String): Boolean

    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`


    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

  2. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  4. abstract def getAttributesCount(): Int

    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`


    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

  5. abstract def getAttributesMap(): Map[String, String]

    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`


    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

  6. abstract def getAttributesOrDefault(key: String, defaultValue: String): String

    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`


    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

  7. abstract def getAttributesOrThrow(key: String): String

    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`


    Optional. Endpoint configuration attributes that can be used to control
different aspects of the message delivery.

The only 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).

If not present during the `CreateSubscription` call, it will default to
the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x-goog-version` 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.

For example:
`attributes { "x-goog-version": "v1" }`

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

  8. abstract def getAuthenticationMethodCase(): AuthenticationMethodCase
  9. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  10. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  11. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  12. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  13. abstract def getNoWrapper(): NoWrapper

    Optional. When set, the payload to the push endpoint is not wrapped.


    Optional. When set, the payload to the push endpoint is not wrapped.

    .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The noWrapper.

  14. abstract def getNoWrapperOrBuilder(): NoWrapperOrBuilder

    Optional. When set, the payload to the push endpoint is not wrapped.


    Optional. When set, the payload to the push endpoint is not wrapped.

    .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];

  15. abstract def getOidcToken(): OidcToken

    Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an `Authorization` header in the HTTP request for every pushed
message.


    Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an `Authorization` header in the HTTP request for every pushed
message.

    .google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The oidcToken.

  16. abstract def getOidcTokenOrBuilder(): OidcTokenOrBuilder

    Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an `Authorization` header in the HTTP request for every pushed
message.


    Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an `Authorization` header in the HTTP request for every pushed
message.

    .google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];

  17. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  18. abstract def getPubsubWrapper(): PubsubWrapper

    Optional. When set, the payload to the push endpoint is in the form of
the JSON representation of a PubsubMessage
(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).


    Optional. When set, the payload to the push endpoint is in the form of
the JSON representation of a PubsubMessage
(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

    .google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The pubsubWrapper.

  19. abstract def getPubsubWrapperOrBuilder(): PubsubWrapperOrBuilder

    Optional. When set, the payload to the push endpoint is in the form of
the JSON representation of a PubsubMessage
(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).


    Optional. When set, the payload to the push endpoint is in the form of
the JSON representation of a PubsubMessage
(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

    .google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];

  20. abstract def getPushEndpoint(): String

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


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The pushEndpoint.

  21. abstract def getPushEndpointBytes(): ByteString

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


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The bytes for pushEndpoint.

  22. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  23. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  24. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  25. abstract def getWrapperCase(): WrapperCase
  26. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  27. abstract def hasNoWrapper(): Boolean

    Optional. When set, the payload to the push endpoint is not wrapped.


    Optional. When set, the payload to the push endpoint is not wrapped.

    .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the noWrapper field is set.

  28. abstract def hasOidcToken(): Boolean

    Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an `Authorization` header in the HTTP request for every pushed
message.


    Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an `Authorization` header in the HTTP request for every pushed
message.

    .google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the oidcToken field is set.

  29. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  30. abstract def hasPubsubWrapper(): Boolean

    Optional. When set, the payload to the push endpoint is in the form of
the JSON representation of a PubsubMessage
(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).


    Optional. When set, the payload to the push endpoint is in the form of
the JSON representation of a PubsubMessage
(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

    .google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the pubsubWrapper field is set.

  31. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder
  32. abstract def getAttributes(): Map[String, String]

    Use #getAttributesMap() instead.

    Use #getAttributesMap() instead.

    Annotations
    @Deprecated
    Deprecated

Concrete 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped