Close httplib2 connections.
create(parent, blockchainNodeId=None, body=None, requestId=None, x__xgafv=None)
Creates a new blockchain node in a given project and location.
delete(name, requestId=None, x__xgafv=None)
Deletes a single blockchain node.
Gets details of a single blockchain node.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists blockchain nodes in a given project and location.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single blockchain node.
close()
Close httplib2 connections.
create(parent, blockchainNodeId=None, body=None, requestId=None, x__xgafv=None)
Creates a new blockchain node in a given project and location.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # A representation of a blockchain node.
"blockchainType": "A String", # Immutable. The blockchain type of the node.
"connectionInfo": { # The connection information through which to interact with a blockchain node. # Output only. The connection information used to interact with a blockchain node.
"endpointInfo": { # Contains endpoint information through which to interact with a blockchain node. # Output only. The endpoint information through which to interact with a blockchain node.
"jsonRpcApiEndpoint": "A String", # Output only. The assigned URL for the node JSON-RPC API endpoint.
"websocketsApiEndpoint": "A String", # Output only. The assigned URL for the node WebSockets API endpoint.
},
"serviceAttachment": "A String", # Output only. A service attachment that exposes a node, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"createTime": "A String", # Output only. The timestamp at which the blockchain node was first created.
"ethereumDetails": { # Ethereum-specific blockchain node details. # Ethereum-specific blockchain node details.
"additionalEndpoints": { # Contains endpoint information specific to Ethereum nodes. # Output only. Ethereum-specific endpoint information.
"beaconApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon API endpoint.
"beaconPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon Prometheus metrics endpoint. See [Prometheus Metrics](https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for more details.
"executionClientPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's execution client's Prometheus metrics endpoint.
},
"apiEnableAdmin": True or False, # Immutable. Enables JSON-RPC access to functions in the `admin` namespace. Defaults to `false`.
"apiEnableDebug": True or False, # Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.
"consensusClient": "A String", # Immutable. The consensus client.
"executionClient": "A String", # Immutable. The execution client
"gethDetails": { # Options for the Geth execution client. See [Command-line Options](https://geth.ethereum.org/docs/fundamentals/command-line-options) for more details. # Details for the Geth execution client.
"garbageCollectionMode": "A String", # Immutable. Blockchain garbage collection mode.
},
"network": "A String", # Immutable. The Ethereum environment being accessed.
"nodeType": "A String", # Immutable. The type of Ethereum node.
"validatorConfig": { # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client. # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.
"beaconFeeRecipient": "A String", # An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as "suggested", as we run the execution node we can trust the execution node, and therefore this is considered enforced.
"managedValidatorClient": True or False, # Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.
"mevRelayUrls": [ # URLs for MEV-relay services to use for block building. When set, a GCP-managed MEV-boost service is configured on the beacon client.
"A String",
],
},
},
"labels": { # User-provided key-value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
"privateServiceConnectEnabled": True or False, # Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect.
"state": "A String", # Output only. A status representing the state of the node.
"updateTime": "A String", # Output only. The timestamp at which the blockchain node was last updated.
}
blockchainNodeId: string, Required. ID of the requesting object.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, requestId=None, x__xgafv=None)
Deletes a single blockchain node.
Args:
name: string, Required. The fully qualified name of the blockchain node to delete. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`. (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets details of a single blockchain node.
Args:
name: string, Required. The fully qualified name of the blockchain node to fetch. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A representation of a blockchain node.
"blockchainType": "A String", # Immutable. The blockchain type of the node.
"connectionInfo": { # The connection information through which to interact with a blockchain node. # Output only. The connection information used to interact with a blockchain node.
"endpointInfo": { # Contains endpoint information through which to interact with a blockchain node. # Output only. The endpoint information through which to interact with a blockchain node.
"jsonRpcApiEndpoint": "A String", # Output only. The assigned URL for the node JSON-RPC API endpoint.
"websocketsApiEndpoint": "A String", # Output only. The assigned URL for the node WebSockets API endpoint.
},
"serviceAttachment": "A String", # Output only. A service attachment that exposes a node, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"createTime": "A String", # Output only. The timestamp at which the blockchain node was first created.
"ethereumDetails": { # Ethereum-specific blockchain node details. # Ethereum-specific blockchain node details.
"additionalEndpoints": { # Contains endpoint information specific to Ethereum nodes. # Output only. Ethereum-specific endpoint information.
"beaconApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon API endpoint.
"beaconPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon Prometheus metrics endpoint. See [Prometheus Metrics](https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for more details.
"executionClientPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's execution client's Prometheus metrics endpoint.
},
"apiEnableAdmin": True or False, # Immutable. Enables JSON-RPC access to functions in the `admin` namespace. Defaults to `false`.
"apiEnableDebug": True or False, # Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.
"consensusClient": "A String", # Immutable. The consensus client.
"executionClient": "A String", # Immutable. The execution client
"gethDetails": { # Options for the Geth execution client. See [Command-line Options](https://geth.ethereum.org/docs/fundamentals/command-line-options) for more details. # Details for the Geth execution client.
"garbageCollectionMode": "A String", # Immutable. Blockchain garbage collection mode.
},
"network": "A String", # Immutable. The Ethereum environment being accessed.
"nodeType": "A String", # Immutable. The type of Ethereum node.
"validatorConfig": { # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client. # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.
"beaconFeeRecipient": "A String", # An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as "suggested", as we run the execution node we can trust the execution node, and therefore this is considered enforced.
"managedValidatorClient": True or False, # Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.
"mevRelayUrls": [ # URLs for MEV-relay services to use for block building. When set, a GCP-managed MEV-boost service is configured on the beacon client.
"A String",
],
},
},
"labels": { # User-provided key-value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
"privateServiceConnectEnabled": True or False, # Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect.
"state": "A String", # Output only. A status representing the state of the node.
"updateTime": "A String", # Output only. The timestamp at which the blockchain node was last updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists blockchain nodes in a given project and location.
Args:
parent: string, Required. Parent value for `ListNodesRequest`. (required)
filter: string, Filtering results.
orderBy: string, Hint for how to order the results.
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing blockchain nodes.
"blockchainNodes": [ # The list of nodes
{ # A representation of a blockchain node.
"blockchainType": "A String", # Immutable. The blockchain type of the node.
"connectionInfo": { # The connection information through which to interact with a blockchain node. # Output only. The connection information used to interact with a blockchain node.
"endpointInfo": { # Contains endpoint information through which to interact with a blockchain node. # Output only. The endpoint information through which to interact with a blockchain node.
"jsonRpcApiEndpoint": "A String", # Output only. The assigned URL for the node JSON-RPC API endpoint.
"websocketsApiEndpoint": "A String", # Output only. The assigned URL for the node WebSockets API endpoint.
},
"serviceAttachment": "A String", # Output only. A service attachment that exposes a node, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"createTime": "A String", # Output only. The timestamp at which the blockchain node was first created.
"ethereumDetails": { # Ethereum-specific blockchain node details. # Ethereum-specific blockchain node details.
"additionalEndpoints": { # Contains endpoint information specific to Ethereum nodes. # Output only. Ethereum-specific endpoint information.
"beaconApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon API endpoint.
"beaconPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon Prometheus metrics endpoint. See [Prometheus Metrics](https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for more details.
"executionClientPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's execution client's Prometheus metrics endpoint.
},
"apiEnableAdmin": True or False, # Immutable. Enables JSON-RPC access to functions in the `admin` namespace. Defaults to `false`.
"apiEnableDebug": True or False, # Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.
"consensusClient": "A String", # Immutable. The consensus client.
"executionClient": "A String", # Immutable. The execution client
"gethDetails": { # Options for the Geth execution client. See [Command-line Options](https://geth.ethereum.org/docs/fundamentals/command-line-options) for more details. # Details for the Geth execution client.
"garbageCollectionMode": "A String", # Immutable. Blockchain garbage collection mode.
},
"network": "A String", # Immutable. The Ethereum environment being accessed.
"nodeType": "A String", # Immutable. The type of Ethereum node.
"validatorConfig": { # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client. # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.
"beaconFeeRecipient": "A String", # An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as "suggested", as we run the execution node we can trust the execution node, and therefore this is considered enforced.
"managedValidatorClient": True or False, # Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.
"mevRelayUrls": [ # URLs for MEV-relay services to use for block building. When set, a GCP-managed MEV-boost service is configured on the beacon client.
"A String",
],
},
},
"labels": { # User-provided key-value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
"privateServiceConnectEnabled": True or False, # Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect.
"state": "A String", # Output only. A status representing the state of the node.
"updateTime": "A String", # Output only. The timestamp at which the blockchain node was last updated.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
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.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single blockchain node.
Args:
name: string, Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`. (required)
body: object, The request body.
The object takes the form of:
{ # A representation of a blockchain node.
"blockchainType": "A String", # Immutable. The blockchain type of the node.
"connectionInfo": { # The connection information through which to interact with a blockchain node. # Output only. The connection information used to interact with a blockchain node.
"endpointInfo": { # Contains endpoint information through which to interact with a blockchain node. # Output only. The endpoint information through which to interact with a blockchain node.
"jsonRpcApiEndpoint": "A String", # Output only. The assigned URL for the node JSON-RPC API endpoint.
"websocketsApiEndpoint": "A String", # Output only. The assigned URL for the node WebSockets API endpoint.
},
"serviceAttachment": "A String", # Output only. A service attachment that exposes a node, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"createTime": "A String", # Output only. The timestamp at which the blockchain node was first created.
"ethereumDetails": { # Ethereum-specific blockchain node details. # Ethereum-specific blockchain node details.
"additionalEndpoints": { # Contains endpoint information specific to Ethereum nodes. # Output only. Ethereum-specific endpoint information.
"beaconApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon API endpoint.
"beaconPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's Beacon Prometheus metrics endpoint. See [Prometheus Metrics](https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for more details.
"executionClientPrometheusMetricsApiEndpoint": "A String", # Output only. The assigned URL for the node's execution client's Prometheus metrics endpoint.
},
"apiEnableAdmin": True or False, # Immutable. Enables JSON-RPC access to functions in the `admin` namespace. Defaults to `false`.
"apiEnableDebug": True or False, # Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.
"consensusClient": "A String", # Immutable. The consensus client.
"executionClient": "A String", # Immutable. The execution client
"gethDetails": { # Options for the Geth execution client. See [Command-line Options](https://geth.ethereum.org/docs/fundamentals/command-line-options) for more details. # Details for the Geth execution client.
"garbageCollectionMode": "A String", # Immutable. Blockchain garbage collection mode.
},
"network": "A String", # Immutable. The Ethereum environment being accessed.
"nodeType": "A String", # Immutable. The type of Ethereum node.
"validatorConfig": { # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client. # Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.
"beaconFeeRecipient": "A String", # An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as "suggested", as we run the execution node we can trust the execution node, and therefore this is considered enforced.
"managedValidatorClient": True or False, # Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.
"mevRelayUrls": [ # URLs for MEV-relay services to use for block building. When set, a GCP-managed MEV-boost service is configured on the beacon client.
"A String",
],
},
},
"labels": { # User-provided key-value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
"privateServiceConnectEnabled": True or False, # Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect.
"state": "A String", # Output only. A status representing the state of the node.
"updateTime": "A String", # Output only. The timestamp at which the blockchain node was last updated.
}
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Blockchain node resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}