blockchainnodeengine

package
v0.196.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package blockchainnodeengine provides access to the Blockchain Node Engine API.

For product documentation, see: https://cloud.google.com/blockchain-node-engine

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/blockchainnodeengine/v1"
...
ctx := context.Background()
blockchainnodeengineService, err := blockchainnodeengine.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

blockchainnodeengineService, err := blockchainnodeengine.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
blockchainnodeengineService, err := blockchainnodeengine.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type BlockchainNode

type BlockchainNode struct {
	// BlockchainType: Immutable. The blockchain type of the node.
	//
	// Possible values:
	//   "BLOCKCHAIN_TYPE_UNSPECIFIED" - Blockchain type has not been specified,
	// but should be.
	//   "ETHEREUM" - The blockchain type is Ethereum.
	BlockchainType string `json:"blockchainType,omitempty"`
	// ConnectionInfo: Output only. The connection information used to interact
	// with a blockchain node.
	ConnectionInfo *ConnectionInfo `json:"connectionInfo,omitempty"`
	// CreateTime: Output only. The timestamp at which the blockchain node was
	// first created.
	CreateTime string `json:"createTime,omitempty"`
	// EthereumDetails: Ethereum-specific blockchain node details.
	EthereumDetails *EthereumDetails `json:"ethereumDetails,omitempty"`
	// Labels: User-provided key-value pairs.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Output only. The fully qualified name of the blockchain node. e.g.
	// `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
	Name string `json:"name,omitempty"`
	// PrivateServiceConnectEnabled: 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.
	PrivateServiceConnectEnabled bool `json:"privateServiceConnectEnabled,omitempty"`
	// State: Output only. A status representing the state of the node.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The state has not been specified.
	//   "CREATING" - The node has been requested and is in the process of being
	// created.
	//   "DELETING" - The existing node is undergoing deletion, but is not yet
	// finished.
	//   "RUNNING" - The node is running and ready for use.
	//   "ERROR" - The node is in an unexpected or errored state.
	//   "UPDATING" - The node is currently being updated.
	//   "REPAIRING" - The node is currently being repaired.
	//   "RECONCILING" - The node is currently being reconciled.
	//   "SYNCING" - The node is syncing, which is the process by which it obtains
	// the latest block and current global state.
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. The timestamp at which the blockchain node was last
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BlockchainType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BlockchainType") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BlockchainNode: A representation of a blockchain node.

func (BlockchainNode) MarshalJSON

func (s BlockchainNode) MarshalJSON() ([]byte, error)

type CancelOperationRequest

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type ConnectionInfo

type ConnectionInfo struct {
	// EndpointInfo: Output only. The endpoint information through which to
	// interact with a blockchain node.
	EndpointInfo *EndpointInfo `json:"endpointInfo,omitempty"`
	// ServiceAttachment: Output only. A service attachment that exposes a node,
	// and has the following format:
	// projects/{project}/regions/{region}/serviceAttachments/{service_attachment_na
	// me}
	ServiceAttachment string `json:"serviceAttachment,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndpointInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndpointInfo") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConnectionInfo: The connection information through which to interact with a blockchain node.

func (ConnectionInfo) MarshalJSON

func (s ConnectionInfo) MarshalJSON() ([]byte, error)

type EndpointInfo

type EndpointInfo struct {
	// JsonRpcApiEndpoint: Output only. The assigned URL for the node JSON-RPC API
	// endpoint.
	JsonRpcApiEndpoint string `json:"jsonRpcApiEndpoint,omitempty"`
	// WebsocketsApiEndpoint: Output only. The assigned URL for the node WebSockets
	// API endpoint.
	WebsocketsApiEndpoint string `json:"websocketsApiEndpoint,omitempty"`
	// ForceSendFields is a list of field names (e.g. "JsonRpcApiEndpoint") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "JsonRpcApiEndpoint") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndpointInfo: Contains endpoint information through which to interact with a blockchain node.

func (EndpointInfo) MarshalJSON

func (s EndpointInfo) MarshalJSON() ([]byte, error)

type EthereumDetails

type EthereumDetails struct {
	// AdditionalEndpoints: Output only. Ethereum-specific endpoint information.
	AdditionalEndpoints *EthereumEndpoints `json:"additionalEndpoints,omitempty"`
	// ApiEnableAdmin: Immutable. Enables JSON-RPC access to functions in the
	// `admin` namespace. Defaults to `false`.
	ApiEnableAdmin bool `json:"apiEnableAdmin,omitempty"`
	// ApiEnableDebug: Immutable. Enables JSON-RPC access to functions in the
	// `debug` namespace. Defaults to `false`.
	ApiEnableDebug bool `json:"apiEnableDebug,omitempty"`
	// ConsensusClient: Immutable. The consensus client.
	//
	// Possible values:
	//   "CONSENSUS_CLIENT_UNSPECIFIED" - Consensus client has not been specified,
	// but should be.
	//   "LIGHTHOUSE" - Consensus client implementation written in Rust, maintained
	// by Sigma Prime. See [Lighthouse - Sigma
	// Prime](https://lighthouse.sigmaprime.io/) for details.
	//   "ERIGON_EMBEDDED_CONSENSUS_LAYER" - Erigon's embedded consensus client
	// embedded in the execution client. Note this option is not currently
	// available when creating new blockchain nodes. See [Erigon on
	// GitHub](https://github.com/ledgerwatch/erigon#embedded-consensus-layer) for
	// details.
	ConsensusClient string `json:"consensusClient,omitempty"`
	// ExecutionClient: Immutable. The execution client
	//
	// Possible values:
	//   "EXECUTION_CLIENT_UNSPECIFIED" - Execution client has not been specified,
	// but should be.
	//   "GETH" - Official Go implementation of the Ethereum protocol. See
	// [go-ethereum](https://geth.ethereum.org/) for details.
	//   "ERIGON" - An implementation of Ethereum (execution client), on the
	// efficiency frontier, written in Go. See [Erigon on
	// GitHub](https://github.com/ledgerwatch/erigon) for details.
	ExecutionClient string `json:"executionClient,omitempty"`
	// GethDetails: Details for the Geth execution client.
	GethDetails *GethDetails `json:"gethDetails,omitempty"`
	// Network: Immutable. The Ethereum environment being accessed.
	//
	// Possible values:
	//   "NETWORK_UNSPECIFIED" - The network has not been specified, but should be.
	//   "MAINNET" - The Ethereum Mainnet.
	//   "TESTNET_GOERLI_PRATER" - Deprecated: The Ethereum Testnet based on Goerli
	// protocol. Please use another test network.
	//   "TESTNET_SEPOLIA" - The Ethereum Testnet based on Sepolia/Bepolia
	// protocol. See https://github.com/eth-clients/sepolia.
	//   "TESTNET_HOLESKY" - The Ethereum Testnet based on Holesky specification.
	// See https://github.com/eth-clients/holesky.
	Network string `json:"network,omitempty"`
	// NodeType: Immutable. The type of Ethereum node.
	//
	// Possible values:
	//   "NODE_TYPE_UNSPECIFIED" - Node type has not been specified, but should be.
	//   "LIGHT" - An Ethereum node that only downloads Ethereum block headers.
	//   "FULL" - Keeps a complete copy of the blockchain data, and contributes to
	// the network by receiving, validating, and forwarding transactions.
	//   "ARCHIVE" - Holds the same data as full node as well as all of the
	// blockchain's history state data dating back to the Genesis Block.
	NodeType string `json:"nodeType,omitempty"`
	// ValidatorConfig: Configuration for validator-related parameters on the
	// beacon client, and for any GCP-managed validator client.
	ValidatorConfig *ValidatorConfig `json:"validatorConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalEndpoints") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalEndpoints") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EthereumDetails: Ethereum-specific blockchain node details.

func (EthereumDetails) MarshalJSON

func (s EthereumDetails) MarshalJSON() ([]byte, error)

type EthereumEndpoints

type EthereumEndpoints struct {
	// BeaconApiEndpoint: Output only. The assigned URL for the node's Beacon API
	// endpoint.
	BeaconApiEndpoint string `json:"beaconApiEndpoint,omitempty"`
	// BeaconPrometheusMetricsApiEndpoint: 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.
	BeaconPrometheusMetricsApiEndpoint string `json:"beaconPrometheusMetricsApiEndpoint,omitempty"`
	// ExecutionClientPrometheusMetricsApiEndpoint: Output only. The assigned URL
	// for the node's execution client's Prometheus metrics endpoint.
	ExecutionClientPrometheusMetricsApiEndpoint string `json:"executionClientPrometheusMetricsApiEndpoint,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BeaconApiEndpoint") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BeaconApiEndpoint") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EthereumEndpoints: Contains endpoint information specific to Ethereum nodes.

func (EthereumEndpoints) MarshalJSON

func (s EthereumEndpoints) MarshalJSON() ([]byte, error)

type GethDetails

type GethDetails struct {
	// GarbageCollectionMode: Immutable. Blockchain garbage collection mode.
	//
	// Possible values:
	//   "GARBAGE_COLLECTION_MODE_UNSPECIFIED" - The garbage collection has not
	// been specified.
	//   "FULL" - Configures Geth's garbage collection so that older data not
	// needed for a full node is deleted. This is the default mode when creating a
	// full node.
	//   "ARCHIVE" - Configures Geth's garbage collection so that old data is never
	// deleted. This is the default mode when creating an archive node. This value
	// can also be chosen when creating a full node in order to create a
	// partial/recent archive node. See [Sync
	// modes](https://geth.ethereum.org/docs/fundamentals/sync-modes) for more
	// details.
	GarbageCollectionMode string `json:"garbageCollectionMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GarbageCollectionMode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GarbageCollectionMode") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GethDetails: Options for the Geth execution client. See Command-line Options (https://geth.ethereum.org/docs/fundamentals/command-line-options) for more details.

func (GethDetails) MarshalJSON

func (s GethDetails) MarshalJSON() ([]byte, error)

type GoogleProtobufEmpty

type GoogleProtobufEmpty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

GoogleProtobufEmpty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type ListBlockchainNodesResponse

type ListBlockchainNodesResponse struct {
	// BlockchainNodes: The list of nodes
	BlockchainNodes []*BlockchainNode `json:"blockchainNodes,omitempty"`
	// NextPageToken: A token identifying a page of results the server should
	// return.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Locations that could not be reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BlockchainNodes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BlockchainNodes") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListBlockchainNodesResponse: Message for response to listing blockchain nodes.

func (ListBlockchainNodesResponse) MarshalJSON

func (s ListBlockchainNodesResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON

func (s Location) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: 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.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// 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.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: 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}`.
	Name string `json:"name,omitempty"`
	// 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`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have been cancelled
	// successfully have `Operation.error` value with a `google.rpc.Status.code` of
	// `1`, corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationMetadata: Represents the metadata of the long-running operation.

func (OperationMetadata) MarshalJSON

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type ProjectsLocationsBlockchainNodesCreateCall

type ProjectsLocationsBlockchainNodesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBlockchainNodesCreateCall) BlockchainNodeId

BlockchainNodeId sets the optional parameter "blockchainNodeId": Required. ID of the requesting object.

func (*ProjectsLocationsBlockchainNodesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBlockchainNodesCreateCall) Do

Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBlockchainNodesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBlockchainNodesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBlockchainNodesCreateCall) RequestId

RequestId sets the optional parameter "requestId": 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 ProjectsLocationsBlockchainNodesDeleteCall

type ProjectsLocationsBlockchainNodesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBlockchainNodesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBlockchainNodesDeleteCall) Do

Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBlockchainNodesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBlockchainNodesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBlockchainNodesDeleteCall) RequestId

RequestId sets the optional parameter "requestId": 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 ProjectsLocationsBlockchainNodesGetCall

type ProjectsLocationsBlockchainNodesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBlockchainNodesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBlockchainNodesGetCall) Do

Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.get" call. Any non-2xx status code is an error. Response headers are in either *BlockchainNode.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBlockchainNodesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBlockchainNodesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBlockchainNodesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsBlockchainNodesListCall

type ProjectsLocationsBlockchainNodesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBlockchainNodesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBlockchainNodesListCall) Do

Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.list" call. Any non-2xx status code is an error. Response headers are in either *ListBlockchainNodesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBlockchainNodesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBlockchainNodesListCall) Filter

Filter sets the optional parameter "filter": Filtering results.

func (*ProjectsLocationsBlockchainNodesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBlockchainNodesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsBlockchainNodesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Hint for how to order the results.

func (*ProjectsLocationsBlockchainNodesListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsBlockchainNodesListCall) PageToken

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsBlockchainNodesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsBlockchainNodesPatchCall

type ProjectsLocationsBlockchainNodesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBlockchainNodesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBlockchainNodesPatchCall) Do

Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBlockchainNodesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBlockchainNodesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBlockchainNodesPatchCall) RequestId

RequestId sets the optional parameter "requestId": 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).

func (*ProjectsLocationsBlockchainNodesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": 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.

type ProjectsLocationsBlockchainNodesService

type ProjectsLocationsBlockchainNodesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsBlockchainNodesService

func NewProjectsLocationsBlockchainNodesService(s *Service) *ProjectsLocationsBlockchainNodesService

func (*ProjectsLocationsBlockchainNodesService) Create

Create: Creates a new blockchain node in a given project and location.

- parent: Value for parent.

func (*ProjectsLocationsBlockchainNodesService) Delete

Delete: Deletes a single blockchain node.

  • name: The fully qualified name of the blockchain node to delete. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.

func (*ProjectsLocationsBlockchainNodesService) Get

Get: Gets details of a single blockchain node.

  • name: The fully qualified name of the blockchain node to fetch. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.

func (*ProjectsLocationsBlockchainNodesService) List

List: Lists blockchain nodes in a given project and location.

- parent: Parent value for `ListNodesRequest`.

func (*ProjectsLocationsBlockchainNodesService) Patch

Patch: Updates the parameters of a single blockchain node.

  • name: Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.

type ProjectsLocationsGetCall

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do

Do executes the "blockchainnodeengine.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsListCall

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do

Do executes the "blockchainnodeengine.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": 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).

func (*ProjectsLocationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsCancelCall

type ProjectsLocationsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall) Do

Do executes the "blockchainnodeengine.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsDeleteCall

type ProjectsLocationsOperationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall) Do

Do executes the "blockchainnodeengine.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall) Do

Do executes the "blockchainnodeengine.projects.locations.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOperationsListCall

type ProjectsLocationsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall) Do

Do executes the "blockchainnodeengine.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: 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`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete

Delete: 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`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get

Get: 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.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	BlockchainNodes *ProjectsLocationsBlockchainNodesService

	Operations *ProjectsLocationsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: 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.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: 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).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type ValidatorConfig

type ValidatorConfig struct {
	// BeaconFeeRecipient: 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.
	BeaconFeeRecipient string `json:"beaconFeeRecipient,omitempty"`
	// ManagedValidatorClient: Immutable. When true, deploys a GCP-managed
	// validator client alongside the beacon client.
	ManagedValidatorClient bool `json:"managedValidatorClient,omitempty"`
	// 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.
	MevRelayUrls []string `json:"mevRelayUrls,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BeaconFeeRecipient") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BeaconFeeRecipient") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ValidatorConfig: Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.

func (ValidatorConfig) MarshalJSON

func (s ValidatorConfig) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL