Class: Google::Apis::PubsubV1::PushConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb

Overview

Configuration for a push delivery endpoint.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PushConfig

Returns a new instance of PushConfig.



844
845
846
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 844

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attributes ⇒ Hash<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" Corresponds to the JSON property attributes

Returns:

  • (Hash<String,String>) 


827
828
829
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 827

def attributes
  @attributes
end

#oidc_token ⇒ Google::Apis::PubsubV1::OidcToken

Contains information needed for generating an OpenID Connect token. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions. Corresponds to the JSON property oidcToken

Returns:



836
837
838
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 836

def oidc_token
  @oidc_token
end

#push_endpoint ⇒ String

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

Returns:

  • (String) 


842
843
844
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 842

def push_endpoint
  @push_endpoint
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



849
850
851
852
853
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 849

def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @oidc_token = args[:oidc_token] if args.key?(:oidc_token)
  @push_endpoint = args[:push_endpoint] if args.key?(:push_endpoint)
end