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, NoWrapper, OidcToken, PubsubWrapper

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:

  • (::Google::Protobuf::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" }



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1295

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]
  #     Optional. [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     used for generating the OIDC token. For more information
  #     on setting up authentication, see
  #     [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
  # @!attribute [rw] audience
  #   @return [::String]
  #     Optional. 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

  # 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).
  class PubsubWrapper
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sets the `data` field as the HTTP body for delivery.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, writes the Pub/Sub message metadata to
  #     `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
  #     Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
  class NoWrapper
    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

#no_wrapper ⇒ ::Google::Cloud::PubSub::V1::PushConfig::NoWrapper

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

Note: The following fields are mutually exclusive: no_wrapper, pubsub_wrapper. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::PubSub::V1::PushConfig::NoWrapper) —

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

    Note: The following fields are mutually exclusive: no_wrapper, pubsub_wrapper. If a field in that set is populated, all other fields in the set will automatically be cleared.



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1295

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]
  #     Optional. [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     used for generating the OIDC token. For more information
  #     on setting up authentication, see
  #     [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
  # @!attribute [rw] audience
  #   @return [::String]
  #     Optional. 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

  # 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).
  class PubsubWrapper
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sets the `data` field as the HTTP body for delivery.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, writes the Pub/Sub message metadata to
  #     `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
  #     Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
  class NoWrapper
    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 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.

Returns:



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1295

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]
  #     Optional. [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     used for generating the OIDC token. For more information
  #     on setting up authentication, see
  #     [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
  # @!attribute [rw] audience
  #   @return [::String]
  #     Optional. 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

  # 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).
  class PubsubWrapper
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sets the `data` field as the HTTP body for delivery.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, writes the Pub/Sub message metadata to
  #     `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
  #     Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
  class NoWrapper
    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

#pubsub_wrapper ⇒ ::Google::Cloud::PubSub::V1::PushConfig::PubsubWrapper

Returns 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).

Note: The following fields are mutually exclusive: pubsub_wrapper, no_wrapper. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1295

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]
  #     Optional. [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     used for generating the OIDC token. For more information
  #     on setting up authentication, see
  #     [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
  # @!attribute [rw] audience
  #   @return [::String]
  #     Optional. 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

  # 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).
  class PubsubWrapper
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sets the `data` field as the HTTP body for delivery.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, writes the Pub/Sub message metadata to
  #     `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
  #     Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
  class NoWrapper
    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 Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

Returns:

  • (::String) —

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



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1295

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]
  #     Optional. [Service account
  #     email](https://cloud.google.com/iam/docs/service-accounts)
  #     used for generating the OIDC token. For more information
  #     on setting up authentication, see
  #     [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
  # @!attribute [rw] audience
  #   @return [::String]
  #     Optional. 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

  # 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).
  class PubsubWrapper
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sets the `data` field as the HTTP body for delivery.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, writes the Pub/Sub message metadata to
  #     `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
  #     Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
  class NoWrapper
    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