Class: Google::Cloud::PubSub::V1::PushConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/pubsub/v1/pubsub.rb

Overview

Configuration for a push delivery endpoint.

Defined Under Namespace

Classes: AttributesEntry, OidcToken

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

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


566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 566

class PushConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # @!attribute [rw] service_account_email
  #   @return [::String]
  #     [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     to be used for generating the OIDC token. The caller (for
  #     CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
  #     have the iam.serviceAccounts.actAs permission for the service account.
  # @!attribute [rw] audience
  #   @return [::String]
  #     Audience to be used when generating OIDC token. The audience claim
  #     identifies the recipients that the JWT is intended for. The audience
  #     value is a single case-sensitive string. Having multiple values (array)
  #     for the audience field is not supported. More info about the OIDC JWT
  #     token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
  #     Note: if not specified, the Push endpoint URL will be used.
  class OidcToken
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#oidc_token ⇒ ::Google::Cloud::PubSub::V1::PushConfig::OidcToken

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

Returns:



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 566

class PushConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # @!attribute [rw] service_account_email
  #   @return [::String]
  #     [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     to be used for generating the OIDC token. The caller (for
  #     CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
  #     have the iam.serviceAccounts.actAs permission for the service account.
  # @!attribute [rw] audience
  #   @return [::String]
  #     Audience to be used when generating OIDC token. The audience claim
  #     identifies the recipients that the JWT is intended for. The audience
  #     value is a single case-sensitive string. Having multiple values (array)
  #     for the audience field is not supported. More info about the OIDC JWT
  #     token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
  #     Note: if not specified, the Push endpoint URL will be used.
  class OidcToken
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#push_endpoint ⇒ ::String

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

Returns:

  • (::String) —

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



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 566

class PushConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # @!attribute [rw] service_account_email
  #   @return [::String]
  #     [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     to be used for generating the OIDC token. The caller (for
  #     CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
  #     have the iam.serviceAccounts.actAs permission for the service account.
  # @!attribute [rw] audience
  #   @return [::String]
  #     Audience to be used when generating OIDC token. The audience claim
  #     identifies the recipients that the JWT is intended for. The audience
  #     value is a single case-sensitive string. Having multiple values (array)
  #     for the audience field is not supported. More info about the OIDC JWT
  #     token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
  #     Note: if not specified, the Push endpoint URL will be used.
  class OidcToken
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end