[Документация Yandex Cloud](../../../../index.md) > [Yandex Application Load Balancer](../../../index.md) > Справочник API > [gRPC (англ.)](../index.md) > [LoadBalancer](index.md) > Update

# Application Load Balancer API, gRPC: LoadBalancerService.Update

Updates the specified application load balancer.

## gRPC request

**rpc Update ([UpdateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))**

## UpdateLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest}

```json
{
  "load_balancer_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "listener_specs": [
    {
      "name": "string",
      "endpoint_specs": [
        {
          "address_specs": [
            {
              // Includes only one of the fields `external_ipv4_address_spec`, `internal_ipv4_address_spec`, `external_ipv6_address_spec`
              "external_ipv4_address_spec": {
                "address": "string"
              },
              "internal_ipv4_address_spec": {
                "address": "string",
                "subnet_id": "string"
              },
              "external_ipv6_address_spec": {
                "address": "string"
              }
              // end of the list of possible fields
            }
          ],
          "ports": [
            "int64"
          ]
        }
      ],
      // Includes only one of the fields `stream`, `http`, `tls`
      "stream": {
        "handler": {
          "backend_group_id": "string",
          "idle_timeout": "google.protobuf.Duration"
        }
      },
      "http": {
        "handler": {
          "http_router_id": "string",
          "rewrite_request_id": "bool",
          // Includes only one of the fields `http2_options`, `allow_http10`
          "http2_options": {
            "max_concurrent_streams": "int64"
          },
          "allow_http10": "bool",
          // end of the list of possible fields
          "preserve_http1_header_casing": "bool"
        },
        "redirects": {
          "http_to_https": "bool"
        }
      },
      "tls": {
        "default_handler": {
          // Includes only one of the fields `stream_handler`, `http_handler`
          "stream_handler": {
            "backend_group_id": "string",
            "idle_timeout": "google.protobuf.Duration"
          },
          "http_handler": {
            "http_router_id": "string",
            "rewrite_request_id": "bool",
            // Includes only one of the fields `http2_options`, `allow_http10`
            "http2_options": {
              "max_concurrent_streams": "int64"
            },
            "allow_http10": "bool",
            // end of the list of possible fields
            "preserve_http1_header_casing": "bool"
          },
          // end of the list of possible fields
          "certificate_ids": [
            "string"
          ],
          "client_certificates_verification": {
            "require_client_certificate": "bool",
            // Includes only one of the fields `bytes`
            "bytes": "string"
            // end of the list of possible fields
          }
        },
        "sni_handlers": [
          {
            "name": "string",
            "server_names": [
              "string"
            ],
            "handler": {
              // Includes only one of the fields `stream_handler`, `http_handler`
              "stream_handler": {
                "backend_group_id": "string",
                "idle_timeout": "google.protobuf.Duration"
              },
              "http_handler": {
                "http_router_id": "string",
                "rewrite_request_id": "bool",
                // Includes only one of the fields `http2_options`, `allow_http10`
                "http2_options": {
                  "max_concurrent_streams": "int64"
                },
                "allow_http10": "bool",
                // end of the list of possible fields
                "preserve_http1_header_casing": "bool"
              },
              // end of the list of possible fields
              "certificate_ids": [
                "string"
              ],
              "client_certificates_verification": {
                "require_client_certificate": "bool",
                // Includes only one of the fields `bytes`
                "bytes": "string"
                // end of the list of possible fields
              }
            }
          }
        ]
      }
      // end of the list of possible fields
    }
  ],
  "allocation_policy": {
    "locations": [
      {
        "zone_id": "string",
        "subnet_id": "string",
        "disable_traffic": "bool",
        "zonal_shift_active": "bool",
        "zonal_traffic_disabled": "bool"
      }
    ]
  },
  "security_group_ids": [
    "string"
  ],
  "auto_scale_policy": {
    "min_zone_size": "int64",
    "max_size": "int64"
  },
  "log_options": {
    "log_group_id": "string",
    "discard_rules": [
      {
        "http_codes": [
          "int64"
        ],
        "http_code_intervals": [
          "HttpCodeInterval"
        ],
        "grpc_codes": [
          "google.rpc.Code"
        ],
        "discard_percent": "google.protobuf.Int64Value"
      }
    ],
    "disable": "bool"
  },
  "allow_zonal_shift": "bool"
}
```

#|
||Field | Description ||
|| load_balancer_id | **string**

Required field. ID of the application load balancer to update.
To get the application load balancer ID, make a [LoadBalancerService.List](list.md#List) request. ||
|| update_mask | **[google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/field-mask)**

Field mask that specifies which attributes of the application load balancer should be updated. ||
|| name | **string**

New name for the application load balancer.
The name must be unique within the folder.

Value must match the regular expression ``` |[a-z][-a-z0-9]{1,61}[a-z0-9] ```. ||
|| description | **string**

New description of the application load balancer.

The maximum string length in characters is 256. ||
|| labels | **object** (map<**string**, **string**>)

New application load balancer labels as `key:value` pairs.
For details about the concept, see [documentation](../../../../overview/concepts/services.md#labels).
Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label:
1. Get the current set of labels with a [LoadBalancerService.Get](get.md#Get) request.
2. Add or remove a label in this set.
3. Send the new set in this field.

The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression ` [a-z][-_0-9a-z]* `. Each value must match the regular expression ` [-_0-9a-z]* `. No more than 64 per resource. ||
|| listener_specs[] | **[ListenerSpec](#yandex.cloud.apploadbalancer.v1.ListenerSpec)**

New listeners for the application load balancer.
For details about the concept,
see [documentation](../../../concepts/application-load-balancer.md#listener).
Existing list of listeners is completely replaced by the specified list, so if you just want to add, update,
or remove a listener, make a [LoadBalancerService.AddListener](addListener.md#AddListener) request,
a [LoadBalancerService.UpdateListener](updateListener.md#UpdateListener) request, or a [LoadBalancerService.RemoveListener](removeListener.md#RemoveListener) request. ||
|| allocation_policy | **[AllocationPolicy](#yandex.cloud.apploadbalancer.v1.AllocationPolicy)**

New locality settings of the application load balancer.
For details about the concept,
see [documentation](../../../concepts/application-load-balancer.md#lb-location).
Existing locality settings are completely replaced by the specified settings,
so if you just want to add or remove an allocation policy:
1. Get the current settings with a [LoadBalancerService.Get](get.md#Get) request.
2. Add or remove a policy in this set.
3. Send the new set in this field. ||
|| security_group_ids[] | **string**

ID's of new security groups attributed to the application load balancer.
For details about the concept,
see [documentation](../../../concepts/application-load-balancer.md#security-groups).
Existing list of security groups is completely replaced by the specified list,
so if you just want to add or remove an allocation policy:
1. Get the current set of security groups with a [LoadBalancerService.Get](get.md#Get) request.
2. Add or remove a group in this set.
3. Send the new set in this field. ||
|| auto_scale_policy | **[AutoScalePolicy](#yandex.cloud.apploadbalancer.v1.AutoScalePolicy)**

New scaling settings of the application load balancer.
The scaling settings relate to a special internal instance group which facilitates the balancer's work.
Instances in this group are called _resource units_. The group is scaled automatically based on incoming load
and within limitations specified in these settings.
For details about the concept,
see [documentation](../../../concepts/application-load-balancer.md#lcu-scaling). ||
|| log_options | **[LogOptions](#yandex.cloud.apploadbalancer.v1.LogOptions)**

Cloud logging settings of the application load balancer. ||
|| allow_zonal_shift | **bool**

Specifies whether application load balancer is available to zonal shift. ||
|#

## ListenerSpec {#yandex.cloud.apploadbalancer.v1.ListenerSpec}

#|
||Field | Description ||
|| name | **string**

Required field. Name of the listener. The name is unique within the application load balancer.

Value must match the regular expression ` [a-z][-a-z0-9]{1,61}[a-z0-9] `. ||
|| endpoint_specs[] | **[EndpointSpec](#yandex.cloud.apploadbalancer.v1.EndpointSpec)**

Endpoints of the listener.
Endpoints are defined by their IP addresses and ports. ||
|| stream | **[StreamListener](#yandex.cloud.apploadbalancer.v1.StreamListener)**

Unencrypted stream (TCP) listener settings.

Includes only one of the fields `stream`, `http`, `tls`.

Listener type and settings. ||
|| http | **[HttpListener](#yandex.cloud.apploadbalancer.v1.HttpListener)**

Unencrypted HTTP listener settings.

Includes only one of the fields `stream`, `http`, `tls`.

Listener type and settings. ||
|| tls | **[TlsListener](#yandex.cloud.apploadbalancer.v1.TlsListener)**

TLS-encrypted HTTP or TCP stream listener settings.
All handlers within a listener ([TlsListener.default_handler](#yandex.cloud.apploadbalancer.v1.TlsListener) and [TlsListener.sni_handlers](#yandex.cloud.apploadbalancer.v1.TlsListener)) must be of one
type, [HttpHandler](#yandex.cloud.apploadbalancer.v1.HttpHandler) or [StreamHandler](#yandex.cloud.apploadbalancer.v1.StreamHandler). Mixing HTTP and TCP stream traffic in a TLS-encrypted listener is not
supported.

Includes only one of the fields `stream`, `http`, `tls`.

Listener type and settings. ||
|#

## EndpointSpec {#yandex.cloud.apploadbalancer.v1.EndpointSpec}

#|
||Field | Description ||
|| address_specs[] | **[AddressSpec](#yandex.cloud.apploadbalancer.v1.AddressSpec)**

Endpoint public (external) and internal addresses.

The number of elements must be greater than 0. ||
|| ports[] | **int64**

Endpoint ports.

The number of elements must be greater than 0. Acceptable values are 1 to 65535, inclusive. ||
|#

## AddressSpec {#yandex.cloud.apploadbalancer.v1.AddressSpec}

#|
||Field | Description ||
|| external_ipv4_address_spec | **[ExternalIpv4AddressSpec](#yandex.cloud.apploadbalancer.v1.ExternalIpv4AddressSpec)**

Public IPv4 endpoint address.

Includes only one of the fields `external_ipv4_address_spec`, `internal_ipv4_address_spec`, `external_ipv6_address_spec`.

Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. ||
|| internal_ipv4_address_spec | **[InternalIpv4AddressSpec](#yandex.cloud.apploadbalancer.v1.InternalIpv4AddressSpec)**

Internal IPv4 endpoint address.
To enable the use of listeners with internal addresses, [contact support](../../../../support/overview.md#response-time).

Includes only one of the fields `external_ipv4_address_spec`, `internal_ipv4_address_spec`, `external_ipv6_address_spec`.

Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. ||
|| external_ipv6_address_spec | **[ExternalIpv6AddressSpec](#yandex.cloud.apploadbalancer.v1.ExternalIpv6AddressSpec)**

Public IPv6 endpoint address.

Includes only one of the fields `external_ipv4_address_spec`, `internal_ipv4_address_spec`, `external_ipv6_address_spec`.

Endpoint address of one of the types: public (external) IPv4 address, internal IPv4 address, public IPv6 address. ||
|#

## ExternalIpv4AddressSpec {#yandex.cloud.apploadbalancer.v1.ExternalIpv4AddressSpec}

#|
||Field | Description ||
|| address | **string**

IPv4 address. ||
|#

## InternalIpv4AddressSpec {#yandex.cloud.apploadbalancer.v1.InternalIpv4AddressSpec}

#|
||Field | Description ||
|| address | **string**

IPv4 address. ||
|| subnet_id | **string**

Required field. ID of the subnet that the address belongs to. ||
|#

## ExternalIpv6AddressSpec {#yandex.cloud.apploadbalancer.v1.ExternalIpv6AddressSpec}

#|
||Field | Description ||
|| address | **string**

IPv6 address. ||
|#

## StreamListener {#yandex.cloud.apploadbalancer.v1.StreamListener}

A stream (TCP) listener resource.

#|
||Field | Description ||
|| handler | **[StreamHandler](#yandex.cloud.apploadbalancer.v1.StreamHandler)**

Required field. Settings for handling stream (TCP) requests. ||
|#

## StreamHandler {#yandex.cloud.apploadbalancer.v1.StreamHandler}

A stream (TCP) handler resource.

#|
||Field | Description ||
|| backend_group_id | **string**

Required field. ID of the backend group processing requests. For details about the concept, see
[documentation](../../../concepts/backend-group.md).
The backend group type, specified via [BackendGroup.backend](../BackendGroup/get.md#yandex.cloud.apploadbalancer.v1.BackendGroup.backend), must be `stream`.
To get the list of all available backend groups, make a [BackendGroupService.List](../BackendGroup/list.md#List) request. ||
|| idle_timeout | **[google.protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/duration)**

The idle timeout is duration during which no data is transmitted or received on either the upstream or downstream connection.
If not configured, the default idle timeout is 1 hour. Setting it to 0 disables the timeout. ||
|#

## HttpListener {#yandex.cloud.apploadbalancer.v1.HttpListener}

An HTTP listener resource.

#|
||Field | Description ||
|| handler | **[HttpHandler](#yandex.cloud.apploadbalancer.v1.HttpHandler)**

Settings for handling HTTP requests.
Only one of `handler` and `redirects` can be specified. ||
|| redirects | **[Redirects](#yandex.cloud.apploadbalancer.v1.Redirects)**

Redirects settings.
Only one of `redirects` and `handler` can be specified. ||
|#

## HttpHandler {#yandex.cloud.apploadbalancer.v1.HttpHandler}

An HTTP handler resource.

#|
||Field | Description ||
|| http_router_id | **string**

ID of the HTTP router processing requests. For details about the concept, see
[documentation](../../../concepts/http-router.md).
To get the list of all available HTTP routers, make a [HttpRouterService.List](../HttpRouter/list.md#List) request. ||
|| rewrite_request_id | **bool**

When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value. ||
|| http2_options | **[Http2Options](#yandex.cloud.apploadbalancer.v1.Http2Options)**

HTTP/2 settings.
If specified, incoming HTTP/2 requests are supported by the listener.

Includes only one of the fields `http2_options`, `allow_http10`.

Protocol settings.
For HTTPS (HTTP over TLS) connections, settings are applied to the protocol
negotiated using TLS [ALPN](https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation) extension. ||
|| allow_http10 | **bool**

Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests.

Includes only one of the fields `http2_options`, `allow_http10`.

Protocol settings.
For HTTPS (HTTP over TLS) connections, settings are applied to the protocol
negotiated using TLS [ALPN](https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation) extension. ||
|| preserve_http1_header_casing | **bool**

When enabled, preserves the original casing of HTTP/1.1 header names (e.g. "CONTENT-Type" -> "CONTENT-Type").
Has no effect on HTTP/2 connections where headers are always lowercase per RFC 7540. ||
|#

## Http2Options {#yandex.cloud.apploadbalancer.v1.Http2Options}

An HTTP/2 options resource.

#|
||Field | Description ||
|| max_concurrent_streams | **int64**

Maximum number of concurrent HTTP/2 streams in a connection. ||
|#

## Redirects {#yandex.cloud.apploadbalancer.v1.Redirects}

A listener redirects resource.

#|
||Field | Description ||
|| http_to_https | **bool**

Redirects all unencrypted HTTP requests to the same URI with scheme changed to `https`.
The setting has the same effect as a single, catch-all [HttpRoute](../HttpRouter/get.md#yandex.cloud.apploadbalancer.v1.HttpRoute)
with [RedirectAction.replace_scheme](../HttpRouter/get.md#yandex.cloud.apploadbalancer.v1.RedirectAction) set to `https`. ||
|#

## TlsListener {#yandex.cloud.apploadbalancer.v1.TlsListener}

TLS-encrypted (HTTP or TCP stream) listener resource.

#|
||Field | Description ||
|| default_handler | **[TlsHandler](#yandex.cloud.apploadbalancer.v1.TlsHandler)**

Required field. Settings for handling requests by default, with Server Name
Indication (SNI) not matching any of the `sni_handlers`. ||
|| sni_handlers[] | **[SniMatch](#yandex.cloud.apploadbalancer.v1.SniMatch)**

Settings for handling requests with Server Name Indication (SNI)
matching one of [SniMatch.server_names](#yandex.cloud.apploadbalancer.v1.SniMatch) values. ||
|#

## TlsHandler {#yandex.cloud.apploadbalancer.v1.TlsHandler}

A TLS-encrypted (HTTP or TCP stream) handler resource.

#|
||Field | Description ||
|| stream_handler | **[StreamHandler](#yandex.cloud.apploadbalancer.v1.StreamHandler)**

Stream (TCP) handler.

Includes only one of the fields `stream_handler`, `http_handler`.

Settings for handling requests. ||
|| http_handler | **[HttpHandler](#yandex.cloud.apploadbalancer.v1.HttpHandler)**

HTTP handler.

Includes only one of the fields `stream_handler`, `http_handler`.

Settings for handling requests. ||
|| certificate_ids[] | **string**

ID's of the TLS server certificates from [Certificate Manager](../../../../certificate-manager/index.md).
RSA and ECDSA certificates are supported, and only the first certificate of each type is used.

The string length in characters for each value must be greater than 1. The maximum number of elements is 1. ||
|| client_certificates_verification | **[ClientCertificatesVerification](#yandex.cloud.apploadbalancer.v1.ClientCertificatesVerification)**

Client certificates verification settings. ||
|#

## ClientCertificatesVerification {#yandex.cloud.apploadbalancer.v1.ClientCertificatesVerification}

Client certificates verification settings.

#|
||Field | Description ||
|| require_client_certificate | **bool**

If true, ALB will reject connections without a valid client certificate. ||
|| bytes | **string**

Trusted certificate authority certificates bundle (PEM text).

Includes only one of the fields `bytes`. ||
|#

## SniMatch {#yandex.cloud.apploadbalancer.v1.SniMatch}

A SNI handler resource.

#|
||Field | Description ||
|| name | **string**

Required field. Name of the SNI handler. ||
|| server_names[] | **string**

Server names that are matched by the SNI handler.

The string length in characters for each value must be 1-255. Each value must match the regular expression ` ([*].)?[-.a-z0-9]+ `. The number of elements must be greater than 0. ||
|| handler | **[TlsHandler](#yandex.cloud.apploadbalancer.v1.TlsHandler)**

Required field. Settings for handling requests with Server Name Indication (SNI) matching one of `server_names` values. ||
|#

## AllocationPolicy {#yandex.cloud.apploadbalancer.v1.AllocationPolicy}

A locality settings (allocation policy) resource.

#|
||Field | Description ||
|| locations[] | **[Location](#yandex.cloud.apploadbalancer.v1.Location)**

Availability zones and subnets that the application load balancer resides.

The minimum number of elements is 1. ||
|#

## Location {#yandex.cloud.apploadbalancer.v1.Location}

An application load balancer location resource.
For details about the concept, see [documentation](../../../concepts/application-load-balancer.md#lb-location).

#|
||Field | Description ||
|| zone_id | **string**

Required field. ID of the availability zone where the application load balancer resides.
Each availability zone can only be specified once. ||
|| subnet_id | **string**

ID of the subnet that the application load balancer belongs to. ||
|| disable_traffic | **bool**

Disables the load balancer node in the specified availability zone.
Backends in the availability zone are not directly affected by this setting.
They still may receive traffic from the load balancer nodes in other availability zones,
subject to [LoadBalancingConfig.locality_aware_routing_percent](../BackendGroup/get.md#yandex.cloud.apploadbalancer.v1.LoadBalancingConfig) and [LoadBalancingConfig.strict_locality](../BackendGroup/get.md#yandex.cloud.apploadbalancer.v1.LoadBalancingConfig) settings. ||
|| zonal_shift_active | **bool**

Show zonal shift status for the location.
Deprecated: use `zonal_traffic_disabled` below to track traffic status. ||
|| zonal_traffic_disabled | **bool**

Computed field: will be set to true if all traffic in zone is disabled
either manually by user or automatically by Cloud infrastructure. ||
|#

## AutoScalePolicy {#yandex.cloud.apploadbalancer.v1.AutoScalePolicy}

A resource for scaling settings of an application load balancer.

#|
||Field | Description ||
|| min_zone_size | **int64**

Lower limit for the number of resource units in each availability zone.
If not specified previously (using other instruments such as management console), the default value is 2.
To revert to it, specify it explicitly.
The minimum value is 2.

Acceptable values are 0 to 1000, inclusive. ||
|| max_size | **int64**

Upper limit for the total number of resource units across all availability zones.
If a positive value is specified, it must be at least `min_zone_size` multiplied by the size of
[AllocationPolicy.locations](#yandex.cloud.apploadbalancer.v1.AllocationPolicy).
If the value is 0, there is no upper limit.

Acceptable values are 0 to 1000, inclusive. ||
|#

## LogOptions {#yandex.cloud.apploadbalancer.v1.LogOptions}

#|
||Field | Description ||
|| log_group_id | **string**

Cloud Logging log group ID to store access logs.
If not set then logs will be stored in default log group for the folder
where load balancer located.

Value must match the regular expression ` ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? `. ||
|| discard_rules[] | **[LogDiscardRule](#yandex.cloud.apploadbalancer.v1.LogDiscardRule)**

ordered list of rules, first matching rule applies ||
|| disable | **bool**

Do not send logs to Cloud Logging log group. ||
|#

## LogDiscardRule {#yandex.cloud.apploadbalancer.v1.LogDiscardRule}

LogDiscardRule discards a fraction of logs with certain codes.
If neither codes or intervals are provided, rule applies to all logs.

#|
||Field | Description ||
|| http_codes[] | **int64**

HTTP codes that should be discarded.

Acceptable values are 100 to 599, inclusive. ||
|| http_code_intervals[] | enum **HttpCodeInterval**

Groups of HTTP codes like 4xx that should be discarded.

- `HTTP_1XX`
- `HTTP_2XX`
- `HTTP_3XX`
- `HTTP_4XX`
- `HTTP_5XX`
- `HTTP_ALL` ||
|| grpc_codes[] | **[google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto)**

GRPC codes that should be discarded ||
|| discard_percent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)**

Percent of logs to be discarded: 0 - keep all, 100 or unset - discard all

Acceptable values are 0 to 100, inclusive. ||
|#

## operation.Operation {#yandex.cloud.operation.Operation}

```json
{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}
```

An Operation resource. For more information, see [Operation](../../../../api-design-guide/concepts/operation.md).

#|
||Field | Description ||
|| id | **string**

ID of the operation. ||
|| description | **string**

Description of the operation. 0-256 characters long. ||
|| created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**

Creation timestamp. ||
|| created_by | **string**

ID of the user or service account who initiated the operation. ||
|| modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**

The time when the Operation resource was last modified. ||
|| done | **bool**

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. ||
|| metadata | **[google.protobuf.Any](https://developers.google.com/protocol-buffers/docs/proto3#any)**

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any. ||
|| error | **[google.rpc.Status](https://cloud.google.com/tasks/docs/reference/rpc/google.rpc#status)**

The error result of the operation in case of failure or cancellation.

Includes only one of the fields `error`, `response`.

The operation result.
If `done == false` and there was no failure detected, neither `error` nor `response` is set.
If `done == false` and there was a failure detected, `error` is set.
If `done == true`, exactly one of `error` or `response` is set. ||
|| response | **[google.protobuf.Any](https://developers.google.com/protocol-buffers/docs/proto3#any)**

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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty).
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields `error`, `response`.

The operation result.
If `done == false` and there was no failure detected, neither `error` nor `response` is set.
If `done == false` and there was a failure detected, `error` is set.
If `done == true`, exactly one of `error` or `response` is set. ||
|#