• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudtasks_v2.html">Cloud Tasks API</a> . <a href="cloudtasks_v2.projects.html">projects</a> . <a href="cloudtasks_v2.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="cloudtasks_v2.projects.locations.queues.html">queues()</a></code>
79</p>
80<p class="firstline">Returns the queues Resource.</p>
81
82<p class="toc_element">
83  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
84<p class="firstline">Gets information about a location.</p>
85<p class="toc_element">
86  <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
87<p class="firstline">Lists information about the supported locations for this service.</p>
88<p class="toc_element">
89  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
93    <code class="details" id="get">get(name, x__xgafv=None)</code>
94  <pre>Gets information about a location.
95
96Args:
97  name: string, Resource name for the location. (required)
98  x__xgafv: string, V1 error format.
99    Allowed values
100      1 - v1 error format
101      2 - v2 error format
102
103Returns:
104  An object of the form:
105
106    { # A resource that represents Google Cloud Platform location.
107    "displayName": "A String", # The friendly name for this location, typically a nearby city name.
108        # For example, "Tokyo".
109    "labels": { # Cross-service attributes for the location. For example
110        #
111        #     {"cloud.googleapis.com/region": "us-east1"}
112      "a_key": "A String",
113    },
114    "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
115    "name": "A String", # Resource name for the location, which may vary between implementations.
116        # For example: `"projects/example-project/locations/us-east1"`
117    "metadata": { # Service-specific metadata. For example the available capacity at the given
118        # location.
119      "a_key": "", # Properties of the object. Contains field @type with type URL.
120    },
121  }</pre>
122</div>
123
124<div class="method">
125    <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
126  <pre>Lists information about the supported locations for this service.
127
128Args:
129  name: string, The resource that owns the locations collection, if applicable. (required)
130  pageToken: string, The standard list page token.
131  x__xgafv: string, V1 error format.
132    Allowed values
133      1 - v1 error format
134      2 - v2 error format
135  pageSize: integer, The standard list page size.
136  filter: string, The standard list filter.
137
138Returns:
139  An object of the form:
140
141    { # The response message for Locations.ListLocations.
142    "nextPageToken": "A String", # The standard List next-page token.
143    "locations": [ # A list of locations that matches the specified filter in the request.
144      { # A resource that represents Google Cloud Platform location.
145        "displayName": "A String", # The friendly name for this location, typically a nearby city name.
146            # For example, "Tokyo".
147        "labels": { # Cross-service attributes for the location. For example
148            #
149            #     {"cloud.googleapis.com/region": "us-east1"}
150          "a_key": "A String",
151        },
152        "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
153        "name": "A String", # Resource name for the location, which may vary between implementations.
154            # For example: `"projects/example-project/locations/us-east1"`
155        "metadata": { # Service-specific metadata. For example the available capacity at the given
156            # location.
157          "a_key": "", # Properties of the object. Contains field @type with type URL.
158        },
159      },
160    ],
161  }</pre>
162</div>
163
164<div class="method">
165    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
166  <pre>Retrieves the next page of results.
167
168Args:
169  previous_request: The request for the previous page. (required)
170  previous_response: The response from the request for the previous page. (required)
171
172Returns:
173  A request object that you can call 'execute()' on to request the next
174  page. Returns None if there are no more items in the collection.
175    </pre>
176</div>
177
178</body></html>