| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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="remotebuildexecution_v1alpha.html">Remote Build Execution API</a> . <a href="remotebuildexecution_v1alpha.projects.html">projects</a> . <a href="remotebuildexecution_v1alpha.projects.instances.html">instances</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="remotebuildexecution_v1alpha.projects.instances.workerpools.html">workerpools()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the workerpools Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 86 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 87 | <p class="firstline">Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="toc_element"> |
| 89 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 90 | <p class="firstline">Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="toc_element"> |
| 92 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Returns the specified instance.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> |
| 96 | <p class="firstline">Lists instances in a project.</p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 98 | <code><a href="#patch">patch(name, body=None, loggingEnabled=None, name1=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 99 | <p class="firstline">Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <h3>Method Details</h3> |
| 101 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 102 | <code class="details" id="close">close()</code> |
| 103 | <pre>Close httplib2 connections.</pre> |
| 104 | </div> |
| 105 | |
| 106 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 108 | <pre>Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | |
| 110 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 111 | parent: string, Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | The object takes the form of: |
| 114 | |
| 115 | { # The request used for `CreateInstance`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 116 | "instance": { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. # Specifies the instance to create. The name in the instance, if specified in the instance, is ignored. |
| 117 | "featurePolicy": { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used. |
| 118 | "containerImageSources": { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ "gcr.io/project-foo", "gcr.io/project-bar/repo-baz", ] } will allow any repositories under "gcr.io/project-foo" plus the repository "gcr.io/project-bar/repo-baz". Default (UNSPECIFIED) is equivalent to any source is allowed. |
| 119 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 120 | "A String", |
| 121 | ], |
| 122 | "policy": "A String", # The policy of the feature. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 123 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 124 | "dockerAddCapabilities": { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed. |
| 125 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 126 | "A String", |
| 127 | ], |
| 128 | "policy": "A String", # The policy of the feature. |
| 129 | }, |
| 130 | "dockerChrootPath": { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used. |
| 131 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 132 | "A String", |
| 133 | ], |
| 134 | "policy": "A String", # The policy of the feature. |
| 135 | }, |
| 136 | "dockerNetwork": { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`. |
| 137 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 138 | "A String", |
| 139 | ], |
| 140 | "policy": "A String", # The policy of the feature. |
| 141 | }, |
| 142 | "dockerPrivileged": { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used. |
| 143 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 144 | "A String", |
| 145 | ], |
| 146 | "policy": "A String", # The policy of the feature. |
| 147 | }, |
| 148 | "dockerRunAsRoot": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used. |
| 149 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 150 | "A String", |
| 151 | ], |
| 152 | "policy": "A String", # The policy of the feature. |
| 153 | }, |
| 154 | "dockerRuntime": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation. |
| 155 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 156 | "A String", |
| 157 | ], |
| 158 | "policy": "A String", # The policy of the feature. |
| 159 | }, |
| 160 | "dockerSiblingContainers": { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used. |
| 161 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 162 | "A String", |
| 163 | ], |
| 164 | "policy": "A String", # The policy of the feature. |
| 165 | }, |
| 166 | "linuxIsolation": "A String", # linux_isolation allows overriding the docker runtime used for containers started on Linux. |
| 167 | }, |
| 168 | "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported. |
| 169 | "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance. |
| 170 | "name": "A String", # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. |
| 171 | "state": "A String", # Output only. State of the instance. |
| 172 | }, |
| 173 | "instanceId": "A String", # ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. |
| 174 | "parent": "A String", # Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. |
| 175 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 176 | |
| 177 | x__xgafv: string, V1 error format. |
| 178 | Allowed values |
| 179 | 1 - v1 error format |
| 180 | 2 - v2 error format |
| 181 | |
| 182 | Returns: |
| 183 | An object of the form: |
| 184 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 185 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 186 | "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. |
| 187 | "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. |
| 188 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 189 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 190 | { |
| 191 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 192 | }, |
| 193 | ], |
| 194 | "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. |
| 195 | }, |
| 196 | "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. |
| 197 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 198 | }, |
| 199 | "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}`. |
| 200 | "response": { # The normal response of the operation in case of success. 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`. |
| 201 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 202 | }, |
| 203 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 204 | </div> |
| 205 | |
| 206 | <div class="method"> |
| 207 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 208 | <pre>Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 209 | |
| 210 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 211 | name: string, Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 212 | x__xgafv: string, V1 error format. |
| 213 | Allowed values |
| 214 | 1 - v1 error format |
| 215 | 2 - v2 error format |
| 216 | |
| 217 | Returns: |
| 218 | An object of the form: |
| 219 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 220 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 221 | "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. |
| 222 | "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. |
| 223 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 224 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 225 | { |
| 226 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 227 | }, |
| 228 | ], |
| 229 | "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. |
| 230 | }, |
| 231 | "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. |
| 232 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 233 | }, |
| 234 | "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}`. |
| 235 | "response": { # The normal response of the operation in case of success. 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`. |
| 236 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 237 | }, |
| 238 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 239 | </div> |
| 240 | |
| 241 | <div class="method"> |
| 242 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 243 | <pre>Returns the specified instance. |
| 244 | |
| 245 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 246 | name: string, Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 247 | x__xgafv: string, V1 error format. |
| 248 | Allowed values |
| 249 | 1 - v1 error format |
| 250 | 2 - v2 error format |
| 251 | |
| 252 | Returns: |
| 253 | An object of the form: |
| 254 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 255 | { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 256 | "featurePolicy": { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used. |
| 257 | "containerImageSources": { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ "gcr.io/project-foo", "gcr.io/project-bar/repo-baz", ] } will allow any repositories under "gcr.io/project-foo" plus the repository "gcr.io/project-bar/repo-baz". Default (UNSPECIFIED) is equivalent to any source is allowed. |
| 258 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 259 | "A String", |
| 260 | ], |
| 261 | "policy": "A String", # The policy of the feature. |
| 262 | }, |
| 263 | "dockerAddCapabilities": { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed. |
| 264 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 265 | "A String", |
| 266 | ], |
| 267 | "policy": "A String", # The policy of the feature. |
| 268 | }, |
| 269 | "dockerChrootPath": { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used. |
| 270 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 271 | "A String", |
| 272 | ], |
| 273 | "policy": "A String", # The policy of the feature. |
| 274 | }, |
| 275 | "dockerNetwork": { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`. |
| 276 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 277 | "A String", |
| 278 | ], |
| 279 | "policy": "A String", # The policy of the feature. |
| 280 | }, |
| 281 | "dockerPrivileged": { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used. |
| 282 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 283 | "A String", |
| 284 | ], |
| 285 | "policy": "A String", # The policy of the feature. |
| 286 | }, |
| 287 | "dockerRunAsRoot": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used. |
| 288 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 289 | "A String", |
| 290 | ], |
| 291 | "policy": "A String", # The policy of the feature. |
| 292 | }, |
| 293 | "dockerRuntime": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation. |
| 294 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 295 | "A String", |
| 296 | ], |
| 297 | "policy": "A String", # The policy of the feature. |
| 298 | }, |
| 299 | "dockerSiblingContainers": { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used. |
| 300 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 301 | "A String", |
| 302 | ], |
| 303 | "policy": "A String", # The policy of the feature. |
| 304 | }, |
| 305 | "linuxIsolation": "A String", # linux_isolation allows overriding the docker runtime used for containers started on Linux. |
| 306 | }, |
| 307 | "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported. |
| 308 | "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance. |
| 309 | "name": "A String", # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. |
| 310 | "state": "A String", # Output only. State of the instance. |
| 311 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 312 | </div> |
| 313 | |
| 314 | <div class="method"> |
| 315 | <code class="details" id="list">list(parent, x__xgafv=None)</code> |
| 316 | <pre>Lists instances in a project. |
| 317 | |
| 318 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 319 | parent: string, Resource name of the project. Format: `projects/[PROJECT_ID]`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 320 | x__xgafv: string, V1 error format. |
| 321 | Allowed values |
| 322 | 1 - v1 error format |
| 323 | 2 - v2 error format |
| 324 | |
| 325 | Returns: |
| 326 | An object of the form: |
| 327 | |
| 328 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 329 | "instances": [ # The list of instances in a given project. |
| 330 | { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. |
| 331 | "featurePolicy": { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used. |
| 332 | "containerImageSources": { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ "gcr.io/project-foo", "gcr.io/project-bar/repo-baz", ] } will allow any repositories under "gcr.io/project-foo" plus the repository "gcr.io/project-bar/repo-baz". Default (UNSPECIFIED) is equivalent to any source is allowed. |
| 333 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 334 | "A String", |
| 335 | ], |
| 336 | "policy": "A String", # The policy of the feature. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 337 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 338 | "dockerAddCapabilities": { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed. |
| 339 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 340 | "A String", |
| 341 | ], |
| 342 | "policy": "A String", # The policy of the feature. |
| 343 | }, |
| 344 | "dockerChrootPath": { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used. |
| 345 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 346 | "A String", |
| 347 | ], |
| 348 | "policy": "A String", # The policy of the feature. |
| 349 | }, |
| 350 | "dockerNetwork": { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`. |
| 351 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 352 | "A String", |
| 353 | ], |
| 354 | "policy": "A String", # The policy of the feature. |
| 355 | }, |
| 356 | "dockerPrivileged": { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used. |
| 357 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 358 | "A String", |
| 359 | ], |
| 360 | "policy": "A String", # The policy of the feature. |
| 361 | }, |
| 362 | "dockerRunAsRoot": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used. |
| 363 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 364 | "A String", |
| 365 | ], |
| 366 | "policy": "A String", # The policy of the feature. |
| 367 | }, |
| 368 | "dockerRuntime": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation. |
| 369 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 370 | "A String", |
| 371 | ], |
| 372 | "policy": "A String", # The policy of the feature. |
| 373 | }, |
| 374 | "dockerSiblingContainers": { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used. |
| 375 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 376 | "A String", |
| 377 | ], |
| 378 | "policy": "A String", # The policy of the feature. |
| 379 | }, |
| 380 | "linuxIsolation": "A String", # linux_isolation allows overriding the docker runtime used for containers started on Linux. |
| 381 | }, |
| 382 | "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported. |
| 383 | "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance. |
| 384 | "name": "A String", # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. |
| 385 | "state": "A String", # Output only. State of the instance. |
| 386 | }, |
| 387 | ], |
| 388 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 389 | </div> |
| 390 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 391 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 392 | <code class="details" id="patch">patch(name, body=None, loggingEnabled=None, name1=None, updateMask=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 393 | <pre>Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion. |
| 394 | |
| 395 | Args: |
| 396 | name: string, Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. (required) |
| 397 | body: object, The request body. |
| 398 | The object takes the form of: |
| 399 | |
| 400 | { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 401 | "featurePolicy": { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used. |
| 402 | "containerImageSources": { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ "gcr.io/project-foo", "gcr.io/project-bar/repo-baz", ] } will allow any repositories under "gcr.io/project-foo" plus the repository "gcr.io/project-bar/repo-baz". Default (UNSPECIFIED) is equivalent to any source is allowed. |
| 403 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 404 | "A String", |
| 405 | ], |
| 406 | "policy": "A String", # The policy of the feature. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 407 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 408 | "dockerAddCapabilities": { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed. |
| 409 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 410 | "A String", |
| 411 | ], |
| 412 | "policy": "A String", # The policy of the feature. |
| 413 | }, |
| 414 | "dockerChrootPath": { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used. |
| 415 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 416 | "A String", |
| 417 | ], |
| 418 | "policy": "A String", # The policy of the feature. |
| 419 | }, |
| 420 | "dockerNetwork": { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`. |
| 421 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 422 | "A String", |
| 423 | ], |
| 424 | "policy": "A String", # The policy of the feature. |
| 425 | }, |
| 426 | "dockerPrivileged": { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used. |
| 427 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 428 | "A String", |
| 429 | ], |
| 430 | "policy": "A String", # The policy of the feature. |
| 431 | }, |
| 432 | "dockerRunAsRoot": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used. |
| 433 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 434 | "A String", |
| 435 | ], |
| 436 | "policy": "A String", # The policy of the feature. |
| 437 | }, |
| 438 | "dockerRuntime": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation. |
| 439 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 440 | "A String", |
| 441 | ], |
| 442 | "policy": "A String", # The policy of the feature. |
| 443 | }, |
| 444 | "dockerSiblingContainers": { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used. |
| 445 | "allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`. |
| 446 | "A String", |
| 447 | ], |
| 448 | "policy": "A String", # The policy of the feature. |
| 449 | }, |
| 450 | "linuxIsolation": "A String", # linux_isolation allows overriding the docker runtime used for containers started on Linux. |
| 451 | }, |
| 452 | "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported. |
| 453 | "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance. |
| 454 | "name": "A String", # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. |
| 455 | "state": "A String", # Output only. State of the instance. |
| 456 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 457 | |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 458 | loggingEnabled: boolean, Deprecated, use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 459 | name1: string, Deprecated, use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 460 | updateMask: string, The update mask applies to instance. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 461 | x__xgafv: string, V1 error format. |
| 462 | Allowed values |
| 463 | 1 - v1 error format |
| 464 | 2 - v2 error format |
| 465 | |
| 466 | Returns: |
| 467 | An object of the form: |
| 468 | |
| 469 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 470 | "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. |
| 471 | "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. |
| 472 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 473 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 474 | { |
| 475 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 476 | }, |
| 477 | ], |
| 478 | "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. |
| 479 | }, |
| 480 | "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. |
| 481 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 482 | }, |
| 483 | "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}`. |
| 484 | "response": { # The normal response of the operation in case of success. 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`. |
| 485 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 486 | }, |
| 487 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 488 | </div> |
| 489 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 490 | </body></html> |