Class: Ansible::Ruby::Modules::Gcpubsub
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Gcpubsub
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb
Overview
Create and Delete Topics/Subscriptions, Publish and pull messages on PubSub. See U(cloud.google.com/pubsub/docs) for an overview.
Instance Method Summary collapse
-
#ack_deadline ⇒ Object?
Subfield of subscription.
-
#name ⇒ Object?
Subfield of subscription.
-
#publish ⇒ Array<Hash>, ...
List of dictionaries describing messages and attributes to be published.
-
#pull ⇒ Object?
Subfield of subscription.
-
#push_endpoint ⇒ Object?
Subfield of subscription.
-
#state ⇒ :absent, ...
State of the topic or queue.,Applies to the most granular resource.,If subscription isspecified we remove it.,If only topic is specified, that is what is removed.,NOTE - A topic can be removed without first removing the subscription.
-
#subscription ⇒ Array<Hash>, ...
Dictionary containing a subscripton name associated with a topic (required), along with optional ack_deadline, push_endpoint and pull.
-
#topic ⇒ String
GCP pubsub topic name.,Only the name, not the full path, is required.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#ack_deadline ⇒ Object?
Returns Subfield of subscription. Not required. Default deadline for subscriptions to ACK the message before it is resent. See examples.
23 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 23 attribute :ack_deadline |
#name ⇒ Object?
Returns Subfield of subscription. Required if subscription is specified. See examples.
20 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 20 attribute :name |
#publish ⇒ Array<Hash>, ...
Returns List of dictionaries describing messages and attributes to be published. Dictionary is in message(str):attributes(dict) format. Only message is required.
32 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 32 attribute :publish |
#pull ⇒ Object?
Returns Subfield of subscription. Not required. If specified, messages will be retrieved from topic via the provided subscription name. max_messages (int; default None; max number of messages to pull), message_ack (bool; default False; acknowledge the message) and return_immediately (bool; default True, don’t wait for messages to appear). If the messages are acknowledged, changed is set to True, otherwise, changed is False.
26 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 26 attribute :pull |
#push_endpoint ⇒ Object?
Returns Subfield of subscription. Not required. If specified, message will be sent to an endpoint. See U(cloud.google.com/pubsub/docs/advanced#push_endpoints) for more information.
29 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 29 attribute :push_endpoint |
#state ⇒ :absent, ...
Returns State of the topic or queue.,Applies to the most granular resource.,If subscription isspecified we remove it.,If only topic is specified, that is what is removed.,NOTE - A topic can be removed without first removing the subscription.
36 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 36 attribute :state |
#subscription ⇒ Array<Hash>, ...
Returns Dictionary containing a subscripton name associated with a topic (required), along with optional ack_deadline, push_endpoint and pull. For pulling from a subscription, message_ack (bool), max_messages (int) and return_immediate are available as subfields. See subfields name, push_endpoint and ack_deadline for more information.
16 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 16 attribute :subscription |
#topic ⇒ String
Returns GCP pubsub topic name.,Only the name, not the full path, is required.
12 |
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcpubsub.rb', line 12 attribute :topic |