gcp_cloudscheduler_job_info – Gather info for GCP Job¶
New in version 2.9.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Parameters¶
Notes¶
Note
- for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.
- for authentication, you can set service_account_contents using the c(GCP_SERVICE_ACCOUNT_CONTENTS) env variable.
- For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable. - For authentication, you can set auth_kind using the
GCP_AUTH_KIND
env variable. - For authentication, you can set scopes using the
GCP_SCOPES
env variable. - Environment variables values will only be used if the playbook values are not set.
- The service_account_email and service_account_file options are mutually exclusive.
Examples¶
- name: get info on a job
gcp_cloudscheduler_job_info:
region: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
resources
complex
|
always |
List of resources
|
|||
appEngineHttpTarget
complex
|
success |
App Engine HTTP target.
If the job providers a App Engine HTTP target the cron will send a request to the service instance .
|
|||
appEngineRouting
complex
|
success |
App Engine Routing setting for the job.
|
|||
instance
string
|
success |
App instance.
By default, the job is sent to an instance which is available when the job is attempted.
|
|||
service
string
|
success |
App service.
By default, the job is sent to the service which is the default service when the job is attempted.
|
|||
version
string
|
success |
App version.
By default, the job is sent to the version which is the default version when the job is attempted.
|
|||
body
string
|
success |
HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
|
|||
headers
dictionary
|
success |
HTTP request headers.
This map contains the header field names and values. Headers can be set when the job is created.
|
|||
httpMethod
string
|
success |
Which HTTP method to use for the request.
|
|||
relativeUri
string
|
success |
The relative URI.
|
|||
description
string
|
success |
A human-readable description for the job. This string must not contain more than 500 characters.
|
|||
httpTarget
complex
|
success |
HTTP target.
If the job providers a http_target the cron will send a request to the targeted url .
|
|||
body
string
|
success |
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
|
|||
headers
dictionary
|
success |
This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
|
|||
httpMethod
string
|
success |
Which HTTP method to use for the request.
|
|||
oauthToken
complex
|
success |
Contains information needed for generating an OAuth token.
This type of authorization should be used when sending requests to a GCP endpoint.
|
|||
scope
string
|
success |
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
|
|||
serviceAccountEmail
string
|
success |
Service account email to be used for generating OAuth token.
The service account must be within the same project as the job.
|
|||
oidcToken
complex
|
success |
Contains information needed for generating an OpenID Connect token.
This type of authorization should be used when sending requests to third party endpoints or Cloud Run.
|
|||
audience
string
|
success |
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
|
|||
serviceAccountEmail
string
|
success |
Service account email to be used for generating OAuth token.
The service account must be within the same project as the job.
|
|||
uri
string
|
success |
The full URI path that the request will be sent to.
|
|||
name
string
|
success |
The name of the job.
|
|||
pubsubTarget
complex
|
success |
Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic .
|
|||
attributes
dictionary
|
success |
Attributes for PubsubMessage.
Pubsub message must contain either non-empty data, or at least one attribute.
|
|||
data
string
|
success |
The message payload for PubsubMessage.
Pubsub message must contain either non-empty data, or at least one attribute.
|
|||
topicName
string
|
success |
The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's PublishRequest.name, for example projects/PROJECT_ID/topics/TOPIC_ID.
|
|||
region
string
|
success |
Region where the scheduler job resides .
|
|||
retryConfig
complex
|
success |
By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings .
|
|||
maxBackoffDuration
string
|
success |
The maximum amount of time to wait before retrying a job after it fails.
A duration in seconds with up to nine fractional digits, terminated by 's'.
|
|||
maxDoublings
integer
|
success |
The time between retries will double maxDoublings times.
A job's retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times.
|
|||
maxRetryDuration
string
|
success |
The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached.
A duration in seconds with up to nine fractional digits, terminated by 's'.
|
|||
minBackoffDuration
string
|
success |
The minimum amount of time to wait before retrying a job after it fails.
A duration in seconds with up to nine fractional digits, terminated by 's'.
|
|||
retryCount
integer
|
success |
The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings.
Values greater than 5 and negative values are not allowed.
|
|||
schedule
string
|
success |
Describes the schedule on which the job will be executed.
|
|||
timeZone
string
|
success |
Specifies the time zone to be used in interpreting schedule.
The value of this field must be a time zone name from the tz database.
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Google Inc. (@googlecloudplatform)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.