| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="baremetalsolution_v2.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v2.projects.html">projects</a> . <a href="baremetalsolution_v2.projects.locations.html">locations</a> . <a href="baremetalsolution_v2.projects.locations.instances.html">instances</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Get details about a single server.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">List servers in a given project and location.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Update details of a single server.</p> | |
| <p class="toc_element"> | |
| <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.</p> | |
| <p class="toc_element"> | |
| <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Starts a server that was shutdown.</p> | |
| <p class="toc_element"> | |
| <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Stop a running server.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Get details about a single server. | |
| Args: | |
| name: string, Required. Name of the resource. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A server. | |
| "createTime": "A String", # Output only. Create a time stamp. | |
| "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. | |
| "id": "A String", # An identifier for the `Instance`, generated by the backend. | |
| "interactiveSerialConsoleEnabled": True or False, # True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. | |
| "labels": { # Labels as key value pairs. | |
| "a_key": "A String", | |
| }, | |
| "luns": [ # List of LUNs associated with this server. | |
| { # A storage volume logical unit number (LUN). | |
| "bootLun": True or False, # Display if this LUN is a boot LUN. | |
| "id": "A String", # An identifier for the LUN, generated by the backend. | |
| "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. | |
| "name": "A String", # Output only. The name of the LUN. | |
| "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. | |
| "sizeGb": "A String", # The size of this LUN, in gigabytes. | |
| "state": "A String", # The state of this storage volume. | |
| "storageType": "A String", # The storage type for this LUN. | |
| "storageVolume": "A String", # Display the storage volume for this LUN. | |
| "wwid": "A String", # The WWID for this LUN. | |
| }, | |
| ], | |
| "machineType": "A String", # The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | |
| "name": "A String", # Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` | |
| "networks": [ # List of networks associated with this server. | |
| { # A Network. | |
| "cidr": "A String", # The cidr of the Network. | |
| "id": "A String", # An identifier for the `Network`, generated by the backend. | |
| "ipAddress": "A String", # IP address configured. | |
| "labels": { # Labels as key value pairs. | |
| "a_key": "A String", | |
| }, | |
| "macAddress": [ # List of physical interfaces. | |
| "A String", | |
| ], | |
| "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` | |
| "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS). | |
| "state": "A String", # The Network state. | |
| "type": "A String", # The type of this network. | |
| "vlanId": "A String", # The vlan id of the Network. | |
| "vrf": { # A network VRF. # The vrf for the Network. | |
| "name": "A String", # The name of the VRF. | |
| "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. | |
| "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps. | |
| }, | |
| "state": "A String", # The possible state of VRF. | |
| "vlanAttachments": [ # The list of VLAN attachments for the VRF. | |
| { # VLAN attachment details. | |
| "peerIp": "A String", # The peer IP of the attachment. | |
| "peerVlanId": "A String", # The peer vlan ID of the attachment. | |
| "routerIp": "A String", # The router IP of the attachment. | |
| }, | |
| ], | |
| }, | |
| }, | |
| ], | |
| "osImage": "A String", # The OS image currently installed on the server. | |
| "state": "A String", # The state of the server. | |
| "updateTime": "A String", # Output only. Update a time stamp. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>List servers in a given project and location. | |
| Args: | |
| parent: string, Required. Parent value for ListInstancesRequest. (required) | |
| filter: string, List filter. | |
| pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default. | |
| pageToken: string, A token identifying a page of results from the server. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response message for the list of servers. | |
| "instances": [ # The list of servers. | |
| { # A server. | |
| "createTime": "A String", # Output only. Create a time stamp. | |
| "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. | |
| "id": "A String", # An identifier for the `Instance`, generated by the backend. | |
| "interactiveSerialConsoleEnabled": True or False, # True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. | |
| "labels": { # Labels as key value pairs. | |
| "a_key": "A String", | |
| }, | |
| "luns": [ # List of LUNs associated with this server. | |
| { # A storage volume logical unit number (LUN). | |
| "bootLun": True or False, # Display if this LUN is a boot LUN. | |
| "id": "A String", # An identifier for the LUN, generated by the backend. | |
| "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. | |
| "name": "A String", # Output only. The name of the LUN. | |
| "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. | |
| "sizeGb": "A String", # The size of this LUN, in gigabytes. | |
| "state": "A String", # The state of this storage volume. | |
| "storageType": "A String", # The storage type for this LUN. | |
| "storageVolume": "A String", # Display the storage volume for this LUN. | |
| "wwid": "A String", # The WWID for this LUN. | |
| }, | |
| ], | |
| "machineType": "A String", # The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | |
| "name": "A String", # Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` | |
| "networks": [ # List of networks associated with this server. | |
| { # A Network. | |
| "cidr": "A String", # The cidr of the Network. | |
| "id": "A String", # An identifier for the `Network`, generated by the backend. | |
| "ipAddress": "A String", # IP address configured. | |
| "labels": { # Labels as key value pairs. | |
| "a_key": "A String", | |
| }, | |
| "macAddress": [ # List of physical interfaces. | |
| "A String", | |
| ], | |
| "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` | |
| "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS). | |
| "state": "A String", # The Network state. | |
| "type": "A String", # The type of this network. | |
| "vlanId": "A String", # The vlan id of the Network. | |
| "vrf": { # A network VRF. # The vrf for the Network. | |
| "name": "A String", # The name of the VRF. | |
| "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. | |
| "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps. | |
| }, | |
| "state": "A String", # The possible state of VRF. | |
| "vlanAttachments": [ # The list of VLAN attachments for the VRF. | |
| { # VLAN attachment details. | |
| "peerIp": "A String", # The peer IP of the attachment. | |
| "peerVlanId": "A String", # The peer vlan ID of the attachment. | |
| "routerIp": "A String", # The router IP of the attachment. | |
| }, | |
| ], | |
| }, | |
| }, | |
| ], | |
| "osImage": "A String", # The OS image currently installed on the server. | |
| "state": "A String", # The state of the server. | |
| "updateTime": "A String", # Output only. Update a time stamp. | |
| }, | |
| ], | |
| "nextPageToken": "A String", # A token identifying a page of results from the server. | |
| "unreachable": [ # Locations that could not be reached. | |
| "A String", | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> | |
| <pre>Update details of a single server. | |
| Args: | |
| name: string, Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # A server. | |
| "createTime": "A String", # Output only. Create a time stamp. | |
| "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false. | |
| "id": "A String", # An identifier for the `Instance`, generated by the backend. | |
| "interactiveSerialConsoleEnabled": True or False, # True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. | |
| "labels": { # Labels as key value pairs. | |
| "a_key": "A String", | |
| }, | |
| "luns": [ # List of LUNs associated with this server. | |
| { # A storage volume logical unit number (LUN). | |
| "bootLun": True or False, # Display if this LUN is a boot LUN. | |
| "id": "A String", # An identifier for the LUN, generated by the backend. | |
| "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. | |
| "name": "A String", # Output only. The name of the LUN. | |
| "shareable": True or False, # Display if this LUN can be shared between multiple physical servers. | |
| "sizeGb": "A String", # The size of this LUN, in gigabytes. | |
| "state": "A String", # The state of this storage volume. | |
| "storageType": "A String", # The storage type for this LUN. | |
| "storageVolume": "A String", # Display the storage volume for this LUN. | |
| "wwid": "A String", # The WWID for this LUN. | |
| }, | |
| ], | |
| "machineType": "A String", # The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | |
| "name": "A String", # Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` | |
| "networks": [ # List of networks associated with this server. | |
| { # A Network. | |
| "cidr": "A String", # The cidr of the Network. | |
| "id": "A String", # An identifier for the `Network`, generated by the backend. | |
| "ipAddress": "A String", # IP address configured. | |
| "labels": { # Labels as key value pairs. | |
| "a_key": "A String", | |
| }, | |
| "macAddress": [ # List of physical interfaces. | |
| "A String", | |
| ], | |
| "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` | |
| "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS). | |
| "state": "A String", # The Network state. | |
| "type": "A String", # The type of this network. | |
| "vlanId": "A String", # The vlan id of the Network. | |
| "vrf": { # A network VRF. # The vrf for the Network. | |
| "name": "A String", # The name of the VRF. | |
| "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. | |
| "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps. | |
| }, | |
| "state": "A String", # The possible state of VRF. | |
| "vlanAttachments": [ # The list of VLAN attachments for the VRF. | |
| { # VLAN attachment details. | |
| "peerIp": "A String", # The peer IP of the attachment. | |
| "peerVlanId": "A String", # The peer vlan ID of the attachment. | |
| "routerIp": "A String", # The router IP of the attachment. | |
| }, | |
| ], | |
| }, | |
| }, | |
| ], | |
| "osImage": "A String", # The OS image currently installed on the server. | |
| "state": "A String", # The state of the server. | |
| "updateTime": "A String", # Output only. Update a time stamp. | |
| } | |
| updateMask: string, The list of fields to update. The only currently supported fields are: `labels` `hyperthreading_enabled` | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "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. | |
| "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. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "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. | |
| }, | |
| "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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "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}`. | |
| "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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code> | |
| <pre>Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on. | |
| Args: | |
| name: string, Required. Name of the resource. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Message requesting to reset a server. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "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. | |
| "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. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "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. | |
| }, | |
| "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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "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}`. | |
| "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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="start">start(name, body=None, x__xgafv=None)</code> | |
| <pre>Starts a server that was shutdown. | |
| Args: | |
| name: string, Required. Name of the resource. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Message requesting to start a server. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "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. | |
| "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. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "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. | |
| }, | |
| "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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "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}`. | |
| "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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code> | |
| <pre>Stop a running server. | |
| Args: | |
| name: string, Required. Name of the resource. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Message requesting to stop a server. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "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. | |
| "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. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "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. | |
| }, | |
| "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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "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}`. | |
| "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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |