Class: Ansible::Ruby::Modules::Gcp_pubsub_subscription

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gcp_pubsub_subscription.rb

Overview

A named resource representing the stream of messages from a single, specific topic, to be delivered to the subscribing application.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#ack_deadline_seconds ⇒ Integer?

Returns This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).,For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes).,If this parameter is 0, a default value of 10 seconds is used.,For push delivery, this value is also used to set the request timeout for the call to the push endpoint.,If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

Returns:

  • (Integer, nil) —

    This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).,For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes).,If this parameter is 0, a default value of 10 seconds is used.,For push delivery, this value is also used to set the request timeout for the call to the push endpoint.,If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_pubsub_subscription.rb', line 28

attribute :ack_deadline_seconds

#name ⇒ String?

Returns Name of the subscription.

Returns:

  • (String, nil) —

    Name of the subscription.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_pubsub_subscription.rb', line 16

attribute :name

#push_config ⇒ Hash?

Returns If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.

Returns:

  • (Hash, nil) —

    If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_pubsub_subscription.rb', line 24

attribute :push_config

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_pubsub_subscription.rb', line 12

attribute :state

#topic ⇒ String?

Returns A reference to a Topic resource.

Returns:

  • (String, nil) —

    A reference to a Topic resource.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_pubsub_subscription.rb', line 20

attribute :topic