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

Inherits:

Object

• Object
• Google::Cloud::PubSub::V1::PushConfig

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

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

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

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

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

• #push_endpoint ⇒ ::String

  A URL locating the endpoint to which messages should be pushed.

Instance Attribute Details

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

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 549

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

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 549

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

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 549

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