| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, 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 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, 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="cloudscheduler_v1.html">Cloud Scheduler API</a> . <a href="cloudscheduler_v1.projects.html">projects</a> . <a href="cloudscheduler_v1.projects.locations.html">locations</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="cloudscheduler_v1.projects.locations.jobs.html">jobs()</a></code> |
| 79 |
</p> |
| 80 |
<p class="firstline">Returns the jobs Resource.</p> |
| 81 |
|
| 82 |
<p class="toc_element"> |
| 83 |
<code><a href="cloudscheduler_v1.projects.locations.operations.html">operations()</a></code> |
| 84 |
</p> |
| 85 |
<p class="firstline">Returns the operations Resource.</p> |
| 86 |
|
| 87 |
<p class="toc_element"> |
| 88 |
<code><a href="#close">close()</a></code></p> |
| 89 |
<p class="firstline">Close httplib2 connections.</p> |
| 90 |
<p class="toc_element"> |
| 91 |
<code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 92 |
<p class="firstline">Gets information about a location.</p> |
| 93 |
<p class="toc_element"> |
| 94 |
<code><a href="#getCmekConfig">getCmekConfig(name, x__xgafv=None)</a></code></p> |
| 95 |
<p class="firstline">Gets the Scheduler config in the project/region.</p> |
| 96 |
<p class="toc_element"> |
| 97 |
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 98 |
<p class="firstline">Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.</p> |
| 99 |
<p class="toc_element"> |
| 100 |
<code><a href="#list_next">list_next()</a></code></p> |
| 101 |
<p class="firstline">Retrieves the next page of results.</p> |
| 102 |
<p class="toc_element"> |
| 103 |
<code><a href="#updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 104 |
<p class="firstline">Initializes or Updates the a scheduler config.</p> |
| 105 |
<h3>Method Details</h3> |
| 106 |
<div class="method"> |
| 107 |
<code class="details" id="close">close()</code> |
| 108 |
<pre>Close httplib2 connections.</pre> |
| 109 |
</div> |
| 110 |
|
| 111 |
<div class="method"> |
| 112 |
<code class="details" id="get">get(name, x__xgafv=None)</code> |
| 113 |
<pre>Gets information about a location. |
| 114 |
|
| 115 |
Args: |
| 116 |
name: string, Resource name for the location. (required) |
| 117 |
x__xgafv: string, V1 error format. |
| 118 |
Allowed values |
| 119 |
1 - v1 error format |
| 120 |
2 - v2 error format |
| 121 |
|
| 122 |
Returns: |
| 123 |
An object of the form: |
| 124 |
|
| 125 |
{ # A resource that represents a Google Cloud location. |
| 126 |
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 127 |
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 128 |
"a_key": "A String", |
| 129 |
}, |
| 130 |
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 131 |
"metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 132 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 133 |
}, |
| 134 |
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 135 |
}</pre> |
| 136 |
</div> |
| 137 |
|
| 138 |
<div class="method"> |
| 139 |
<code class="details" id="getCmekConfig">getCmekConfig(name, x__xgafv=None)</code> |
| 140 |
<pre>Gets the Scheduler config in the project/region. |
| 141 |
|
| 142 |
Args: |
| 143 |
name: string, Required. The config name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig (required) |
| 144 |
x__xgafv: string, V1 error format. |
| 145 |
Allowed values |
| 146 |
1 - v1 error format |
| 147 |
2 - v2 error format |
| 148 |
|
| 149 |
Returns: |
| 150 |
An object of the form: |
| 151 |
|
| 152 |
{ # Describes the project/location configuration of Cloud Scheduler Resources. |
| 153 |
"kmsKeyName": "A String", # Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption. |
| 154 |
"name": "A String", # Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` |
| 155 |
}</pre> |
| 156 |
</div> |
| 157 |
|
| 158 |
<div class="method"> |
| 159 |
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 160 |
<pre>Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. |
| 161 |
|
| 162 |
Args: |
| 163 |
name: string, The resource that owns the locations collection, if applicable. (required) |
| 164 |
extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated) |
| 165 |
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| 166 |
pageSize: integer, The maximum number of results to return. If not set, the service selects a default. |
| 167 |
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| 168 |
x__xgafv: string, V1 error format. |
| 169 |
Allowed values |
| 170 |
1 - v1 error format |
| 171 |
2 - v2 error format |
| 172 |
|
| 173 |
Returns: |
| 174 |
An object of the form: |
| 175 |
|
| 176 |
{ # The response message for Locations.ListLocations. |
| 177 |
"locations": [ # A list of locations that matches the specified filter in the request. |
| 178 |
{ # A resource that represents a Google Cloud location. |
| 179 |
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 180 |
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 181 |
"a_key": "A String", |
| 182 |
}, |
| 183 |
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 184 |
"metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 185 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 186 |
}, |
| 187 |
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 188 |
}, |
| 189 |
], |
| 190 |
"nextPageToken": "A String", # The standard List next-page token. |
| 191 |
}</pre> |
| 192 |
</div> |
| 193 |
|
| 194 |
<div class="method"> |
| 195 |
<code class="details" id="list_next">list_next()</code> |
| 196 |
<pre>Retrieves the next page of results. |
| 197 |
|
| 198 |
Args: |
| 199 |
previous_request: The request for the previous page. (required) |
| 200 |
previous_response: The response from the request for the previous page. (required) |
| 201 |
|
| 202 |
Returns: |
| 203 |
A request object that you can call 'execute()' on to request the next |
| 204 |
page. Returns None if there are no more items in the collection. |
| 205 |
</pre> |
| 206 |
</div> |
| 207 |
|
| 208 |
<div class="method"> |
| 209 |
<code class="details" id="updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 210 |
<pre>Initializes or Updates the a scheduler config. |
| 211 |
|
| 212 |
Args: |
| 213 |
name: string, Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required) |
| 214 |
body: object, The request body. |
| 215 |
The object takes the form of: |
| 216 |
|
| 217 |
{ # Describes the project/location configuration of Cloud Scheduler Resources. |
| 218 |
"kmsKeyName": "A String", # Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption. |
| 219 |
"name": "A String", # Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` |
| 220 |
} |
| 221 |
|
| 222 |
updateMask: string, Optional. List of fields to be updated in this request. |
| 223 |
x__xgafv: string, V1 error format. |
| 224 |
Allowed values |
| 225 |
1 - v1 error format |
| 226 |
2 - v2 error format |
| 227 |
|
| 228 |
Returns: |
| 229 |
An object of the form: |
| 230 |
|
| 231 |
{ # This resource represents a long-running operation that is the result of a network API call. |
| 232 |
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 233 |
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 234 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 235 |
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 236 |
{ |
| 237 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 238 |
}, |
| 239 |
], |
| 240 |
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 241 |
}, |
| 242 |
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 243 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 244 |
}, |
| 245 |
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 246 |
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 247 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 248 |
}, |
| 249 |
}</pre> |
| 250 |
</div> |
| 251 |
|
| 252 |
</body></html> |