forked from GoogleCloudPlatform/python-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpull_queue_snippets.py
More file actions
162 lines (126 loc) · 4.82 KB
/
pull_queue_snippets.py
File metadata and controls
162 lines (126 loc) · 4.82 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
#!/usr/bin/env python
# Copyright 2017 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Sample command-line program for interacting with the Cloud Tasks API.
See README.md for instructions on setting up your development environment
and running the scripts.
"""
import argparse
import base64
# [START cloud_tasks_create_task]
def create_task(project, queue, location):
"""Create a task for a given queue with an arbitrary payload."""
import googleapiclient.discovery
# Create a client.
client = googleapiclient.discovery.build('cloudtasks', 'v2beta2')
# Prepare the payload.
payload = 'a message for the recipient'
# The API expects base64 encoding of the payload, so encode the unicode
# `payload` object into a byte string and base64 encode it.
base64_encoded_payload = base64.b64encode(payload.encode())
# The request body object will be emitted in JSON, which requires
# unicode objects, so convert the byte string to unicode (still base64).
converted_payload = base64_encoded_payload.decode()
# Construct the request body.
task = {
'task': {
'pull_message': {
'payload': converted_payload
}
}
}
# Construct the fully qualified queue name.
queue_name = 'projects/{}/locations/{}/queues/{}'.format(
project, location, queue)
# Use the client to build and send the task.
response = client.projects().locations().queues().tasks().create(
parent=queue_name, body=task).execute()
print('Created task {}'.format(response['name']))
return response
# [END cloud_tasks_create_task]
# [START cloud_tasks_pull_task]
def pull_task(project, queue, location):
"""Pull a single task from a given queue and lease it for 10 minutes."""
import googleapiclient.discovery
# Create a client.
client = googleapiclient.discovery.build('cloudtasks', 'v2beta2')
duration_seconds = '600s'
pull_options = {
'max_tasks': 1,
'leaseDuration': duration_seconds,
'responseView': 'FULL'
}
queue_name = 'projects/{}/locations/{}/queues/{}'.format(
project, location, queue)
response = client.projects().locations().queues().tasks().pull(
name=queue_name, body=pull_options).execute()
print('Pulled task {}'.format(response))
return response['tasks'][0]
# [END cloud_tasks_pull_task]
def acknowledge_task(task):
"""Acknowledge a given task."""
import googleapiclient.discovery
# Create a client.
client = googleapiclient.discovery.build('cloudtasks', 'v2beta2')
body = {'scheduleTime': task['scheduleTime']}
client.projects().locations().queues().tasks().acknowledge(
name=task['name'], body=body).execute()
print('Acknowledged task {}'.format(task['name']))
if __name__ == '__main__':
parser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)
subparsers = parser.add_subparsers(dest='command')
create_task_parser = subparsers.add_parser(
'create-task',
help=create_task.__doc__)
create_task_parser.add_argument(
'--project',
help='Project of the queue to add the task to.',
required=True,
)
create_task_parser.add_argument(
'--queue',
help='ID (short name) of the queue to add the task to.',
required=True,
)
create_task_parser.add_argument(
'--location',
help='Location of the queue to add the task to.',
required=True,
)
pull_and_ack_parser = subparsers.add_parser(
'pull-and-ack-task',
help=create_task.__doc__)
pull_and_ack_parser.add_argument(
'--project',
help='Project of the queue to pull the task from.',
required=True,
)
pull_and_ack_parser.add_argument(
'--queue',
help='ID (short name) of the queue to pull the task from.',
required=True,
)
pull_and_ack_parser.add_argument(
'--location',
help='Location of the queue to pull the task from.',
required=True,
)
args = parser.parse_args()
if args.command == 'create-task':
create_task(args.project, args.queue, args.location)
if args.command == 'pull-and-ack-task':
task = pull_task(args.project, args.queue, args.location)
acknowledge_task(task)