delowan.googlecloud.gcp_pubsub_subscription_info (1.0.2) — module

Gather info for GCP Subscription

Authors: Google Inc. (@googlecloudplatform)

preview | supported by community

Install collection

Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2


Add to requirements.yml

  collections:
    - name: delowan.googlecloud
      version: 1.0.2

Description

Gather info for GCP Subscription


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get info on a subscription
  gcp_pubsub_subscription_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Inputs

    
scopes:
    description:
    - Array of scopes to be used
    elements: str
    type: list

project:
    description:
    - The Google Cloud Platform project to use.
    type: str

env_type:
    description:
    - Specifies which Ansible environment you're running this module within.
    - This should not be set unless you know what you're doing.
    - This only alters the User Agent string for any API requests.
    type: str

auth_kind:
    choices:
    - application
    - machineaccount
    - serviceaccount
    description:
    - The type of credential used.
    required: true
    type: str

service_account_file:
    description:
    - The path of a Service Account JSON file if serviceaccount is selected as type.
    type: path

service_account_email:
    description:
    - An optional service account email address if machineaccount is selected and the
      user does not wish to use the default email.
    type: str

service_account_contents:
    description:
    - The contents of a Service Account JSON file, either in a dictionary or as a JSON
      string that represents it.
    type: jsonarg

Outputs

resources:
  contains:
    ackDeadlineSeconds:
      description:
      - 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.
      returned: success
      type: int
    deadLetterPolicy:
      contains:
        deadLetterTopic:
          description:
          - The name of the topic to which dead letter messages should be published.
          - Format is `projects/{project}/topics/{topic}`.
          - The Cloud Pub/Sub service account associated with the enclosing subscription's
            parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com)
            must have permission to Publish() to this topic.
          - The operation will fail if the topic does not exist.
          - Users should ensure that there is a subscription attached to this topic
            since messages published to a topic with no subscriptions are lost.
          returned: success
          type: str
        maxDeliveryAttempts:
          description:
          - The maximum number of delivery attempts for any message. The value must
            be between 5 and 100.
          - The number of delivery attempts is defined as 1 + (the sum of number of
            NACKs and number of times the acknowledgement deadline has been exceeded
            for the message).
          - A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client
            libraries may automatically extend ack_deadlines.
          - This field will be honored on a best effort basis.
          - If this parameter is 0, a default value of 5 is used.
          returned: success
          type: int
      description:
      - A policy that specifies the conditions for dead lettering messages in this
        subscription. If dead_letter_policy is not set, dead lettering is disabled.
      - The Cloud Pub/Sub service account associated with this subscription's parent
        project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com)
        must have permission to Acknowledge() messages on this subscription.
      returned: success
      type: complex
    enableMessageOrdering:
      description:
      - If `true`, messages published with the same orderingKey in PubsubMessage will
        be delivered to the subscribers in the order in which they are received by
        the Pub/Sub system. Otherwise, they may be delivered in any order.
      returned: success
      type: bool
    expirationPolicy:
      contains:
        ttl:
          description:
          - Specifies the "time-to-live" duration for an associated resource. The
            resource expires if it is not active for a period of ttl.
          - If ttl is not set, the associated resource never expires.
          - A duration in seconds with up to nine fractional digits, terminated by
            's'.
          - Example - "3.5s".
          returned: success
          type: str
      description:
      - A policy that specifies the conditions for this subscription's expiration.
      - A subscription is considered active as long as any connected subscriber is
        successfully consuming messages from the subscription or is issuing operations
        on the subscription. If expirationPolicy is not set, a default policy with
        ttl of 31 days will be used. If it is set but ttl is "", the resource never
        expires. The minimum allowed value for expirationPolicy.ttl is 1 day.
      returned: success
      type: complex
    filter:
      description:
      - The subscription only delivers the messages that match the filter. Pub/Sub
        automatically acknowledges the messages that don't match the filter. You can
        filter messages by their attributes. The maximum length of a filter is 256
        bytes. After creating the subscription, you can't modify the filter.
      returned: success
      type: str
    labels:
      description:
      - A set of key/value label pairs to assign to this Subscription.
      returned: success
      type: dict
    messageRetentionDuration:
      description:
      - How long to retain unacknowledged messages in the subscription's backlog,
        from the moment a message is published. If retainAckedMessages is true, then
        this also configures the retention of acknowledged messages, and thus configures
        how far back in time a subscriptions.seek can be done. Defaults to 7 days.
        Cannot be more than 7 days (`"604800s"`) or less than 10 minutes (`"600s"`).
      - 'A duration in seconds with up to nine fractional digits, terminated by ''s''.
        Example: `"600.5s"`.'
      returned: success
      type: str
    name:
      description:
      - Name of the subscription.
      returned: success
      type: str
    pushConfig:
      contains:
        attributes:
          description:
          - Endpoint configuration attributes.
          - Every endpoint has a set of API supported attributes that can be used
            to control different aspects of the message delivery.
          - The 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). The endpoint version
            is based on the version of the Pub/Sub API.
          - If not present during the subscriptions.create call, it will default to
            the version of the API used to make such call. If not present during a
            subscriptions.modifyPushConfig call, its value will not be changed. subscriptions.get
            calls will always return a valid version, even if the subscription was
            created without this attribute.
          - 'The possible values for this 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.'
          returned: success
          type: dict
        oidcToken:
          contains:
            audience:
              description:
              - '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: U(https://tools.ietf.org/html/rfc7519#section-4.1.3)
                Note: if not specified, the Push endpoint URL will be used.'
              returned: success
              type: str
            serviceAccountEmail:
              description:
              - Service account email to be used for generating the OIDC token.
              - The caller (for subscriptions.create, subscriptions.patch, and subscriptions.modifyPushConfig
                RPCs) must have the iam.serviceAccounts.actAs permission for the service
                account.
              returned: success
              type: str
          description:
          - If specified, Pub/Sub will generate and attach an OIDC JWT token as an
            Authorization header in the HTTP request for every pushed message.
          returned: success
          type: complex
        pushEndpoint:
          description:
          - A URL locating the endpoint to which messages should be pushed.
          - For example, a Webhook endpoint might use "U(https://example.com/push").
          returned: success
          type: str
      description:
      - 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.
      returned: success
      type: complex
    retainAckedMessages:
      description:
      - Indicates whether to retain acknowledged messages. If `true`, then messages
        are not expunged from the subscription's backlog, even if they are acknowledged,
        until they fall out of the messageRetentionDuration window.
      returned: success
      type: bool
    retryPolicy:
      contains:
        maximumBackoff:
          description:
          - 'The maximum delay between consecutive deliveries of a given message.
            Value should be between 0 and 600 seconds. Defaults to 600 seconds. A
            duration in seconds with up to nine fractional digits, terminated by ''s''.
            Example: "3.5s".'
          returned: success
          type: str
        minimumBackoff:
          description:
          - The minimum delay between consecutive deliveries of a given message. Value
            should be between 0 and 600 seconds. Defaults to 10 seconds.
          - 'A duration in seconds with up to nine fractional digits, terminated by
            ''s''. Example: "3.5s".'
          returned: success
          type: str
      description:
      - A policy that specifies how Pub/Sub retries message delivery for this subscription.
      - If not set, the default retry policy is applied. This generally implies that
        messages will be retried as soon as possible for healthy subscribers. RetryPolicy
        will be triggered on NACKs or acknowledgement deadline exceeded events for
        a given message .
      returned: success
      type: complex
    topic:
      description:
      - A reference to a Topic resource.
      returned: success
      type: dict
  description: List of resources
  returned: always
  type: complex