2023-06-28
▼ ▲ blockchainnodeengine.projects.locations.get
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Resource name for the location.
Description: Gets information about a location.
▼ ▲ blockchainnodeengine.projects.locations.list
Flat Path: v1/projects/{projectsId}/locations
HTTP Method: GET
Parameters:
pageToken
Type: string
Location: query
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
filter
Type: string
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location: query
name
Type: string
Location: path
Pattern: ^projects/[^/]+$
Description: The resource that owns the locations collection, if applicable.
Required: Yes
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Type: integer
Format: int32
Location: query
Parameter Order: name
Description: Lists information about the supported locations for this service.
Path: v1/{+name}/locations
▼ ▲ blockchainnodeengine.projects.locations.blockchainNodes.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single blockchain node.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}
Parameter Order: name
Parameters:
requestId
Location: query
Description: 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).
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$
Location: path
Description: Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
Type: string
Required: Yes
updateMask
Format: google-fieldmask
Location: query
Type: string
Description: 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.
HTTP Method: PATCH
Path: v1/{+name}
▼ ▲ blockchainnodeengine.projects.locations.blockchainNodes.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single blockchain node.
HTTP Method: DELETE
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$
Location: path
Type: string
Description: Required. The fully qualified name of the blockchain node to delete. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
Required: Yes
requestId
Description: 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).
Type: string
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}
Parameter Order: name
▼ ▲ blockchainnodeengine.projects.locations.blockchainNodes.get
Description: Gets details of a single blockchain node.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$
Required: Yes
Location: path
Description: Required. The fully qualified name of the blockchain node to fetch. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
Path: v1/{+name}
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}
Parameter Order: name
▼ ▲ blockchainnodeengine.projects.locations.blockchainNodes.list
HTTP Method: GET
Parameter Order: parent
Description: Lists blockchain nodes in a given project and location.
Parameters:
filter
Type: string
Description: Filtering results.
Location: query
parent
Location: path
Description: Required. Parent value for `ListNodesRequest`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
orderBy
Type: string
Location: query
Description: Hint for how to order the results.
pageToken
Description: A token identifying a page of results the server should return.
Type: string
Location: query
pageSize
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Format: int32
Type: integer
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes
Path: v1/{+parent}/blockchainNodes
▼ ▲ blockchainnodeengine.projects.locations.blockchainNodes.create
HTTP Method: POST
Parameters:
requestId
Type: string
Description: 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).
Location: query
parent
Type: string
Required: Yes
Location: path
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
blockchainNodeId
Description: Required. ID of the requesting object.
Location: query
Type: string
Parameter Order: parent
Path: v1/{+parent}/blockchainNodes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes
Description: Creates a new blockchain node in a given project and location.
▼ ▲ blockchainnodeengine.projects.locations.operations.cancel
Path: v1/{+name}:cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
HTTP Method: POST
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ blockchainnodeengine.projects.locations.operations.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Path: v1/{+name}/operations
Parameters:
filter
Location: query
Type: string
Description: The standard list filter.
pageSize
Type: integer
Description: The standard list page size.
Location: query
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: The name of the operation's parent resource.
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ blockchainnodeengine.projects.locations.operations.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: GET
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Description: The name of the operation resource.
▼ ▲ blockchainnodeengine.projects.locations.operations.delete
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Type: string
Required: Yes
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE