OAuth2 scopes used by this API.
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"
)
AcceleratorConfig: A TPU accelerator configuration.
type AcceleratorConfig struct {
// Topology: Required. Topology of TPU in chips.
Topology string `json:"topology,omitempty"`
// Type: Required. Type of TPU.
//
// Possible values:
// "TYPE_UNSPECIFIED" - Unspecified version.
// "V2" - TPU v2.
// "V3" - TPU v3.
// "V4" - TPU v4.
// "V5P" - TPU v5.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Topology") 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. "Topology") 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:"-"`
}
func (s *AcceleratorConfig) MarshalJSON() ([]byte, error)
AcceleratorType: A accelerator type that a Node can be configured with.
type AcceleratorType struct {
// AcceleratorConfigs: The accelerator config.
AcceleratorConfigs []*AcceleratorConfig `json:"acceleratorConfigs,omitempty"`
// Name: The resource name.
Name string `json:"name,omitempty"`
// Type: The accelerator type.
Type string `json:"type,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AcceleratorConfigs") 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. "AcceleratorConfigs") 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:"-"`
}
func (s *AcceleratorType) MarshalJSON() ([]byte, error)
AcceptedData: Further data for the accepted state.
type AcceptedData struct {
}
AccessConfig: An access config attached to the TPU worker.
type AccessConfig struct {
// ExternalIp: Output only. An external IP address associated with the TPU
// worker.
ExternalIp string `json:"externalIp,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExternalIp") 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. "ExternalIp") 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:"-"`
}
func (s *AccessConfig) MarshalJSON() ([]byte, error)
ActiveData: Further data for the active state.
type ActiveData struct {
}
AttachedDisk: A node-attached disk resource. Next ID: 8;
type AttachedDisk struct {
// Mode: The mode in which to attach this disk. If not specified, the default
// is READ_WRITE mode. Only applicable to data_disks.
//
// Possible values:
// "DISK_MODE_UNSPECIFIED" - The disk mode is not known/set.
// "READ_WRITE" - Attaches the disk in read-write mode. Only one TPU node can
// attach a disk in read-write mode at a time.
// "READ_ONLY" - Attaches the disk in read-only mode. Multiple TPU nodes can
// attach a disk in read-only mode at a time.
Mode string `json:"mode,omitempty"`
// SourceDisk: Specifies the full path to an existing disk. For example:
// "projects/my-project/zones/us-central1-c/disks/my-disk".
SourceDisk string `json:"sourceDisk,omitempty"`
// ForceSendFields is a list of field names (e.g. "Mode") 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. "Mode") 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:"-"`
}
func (s *AttachedDisk) MarshalJSON() ([]byte, error)
BestEffort: BestEffort tier definition.
type BestEffort struct {
}
BootDiskConfig: Boot disk configurations.
type BootDiskConfig struct {
// CustomerEncryptionKey: Optional. Customer encryption key for boot disk.
CustomerEncryptionKey *CustomerEncryptionKey `json:"customerEncryptionKey,omitempty"`
// EnableConfidentialCompute: Optional. Whether the boot disk will be created
// with confidential compute mode.
EnableConfidentialCompute bool `json:"enableConfidentialCompute,omitempty"`
// ForceSendFields is a list of field names (e.g. "CustomerEncryptionKey") 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. "CustomerEncryptionKey") 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:"-"`
}
func (s *BootDiskConfig) MarshalJSON() ([]byte, error)
CreatingData: Further data for the creating state.
type CreatingData struct {
}
CustomerEncryptionKey: Customer's encryption key.
type CustomerEncryptionKey struct {
// KmsKeyName: The name of the encryption key that is stored in Google Cloud
// KMS. For example: "kmsKeyName":
// "projects/kms_project_id/locations/region/keyRings/
// key_region/cryptoKeys/key The fully-qualifed key name may be returned for
// resource GET requests. For example: "kmsKeyName":
// "projects/kms_project_id/locations/region/keyRings/
// key_region/cryptoKeys/key /cryptoKeyVersions/1
KmsKeyName string `json:"kmsKeyName,omitempty"`
// ForceSendFields is a list of field names (e.g. "KmsKeyName") 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. "KmsKeyName") 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:"-"`
}
func (s *CustomerEncryptionKey) MarshalJSON() ([]byte, error)
DeletingData: Further data for the deleting state.
type DeletingData struct {
}
Empty: 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 Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
FailedData: Further data for the failed state.
type FailedData struct {
// Error: The error that caused the queued resource to enter the FAILED state.
Error *Status `json:"error,omitempty"`
// ForceSendFields is a list of field names (e.g. "Error") 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. "Error") 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:"-"`
}
func (s *FailedData) MarshalJSON() ([]byte, error)
GenerateServiceIdentityRequest: Request for GenerateServiceIdentity.
type GenerateServiceIdentityRequest struct {
}
GenerateServiceIdentityResponse: Response for GenerateServiceIdentity.
type GenerateServiceIdentityResponse struct {
// Identity: ServiceIdentity that was created or retrieved.
Identity *ServiceIdentity `json:"identity,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Identity") 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. "Identity") 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:"-"`
}
func (s *GenerateServiceIdentityResponse) MarshalJSON() ([]byte, error)
GetGuestAttributesRequest: Request for GetGuestAttributes.
type GetGuestAttributesRequest struct {
// QueryPath: The guest attributes path to be queried.
QueryPath string `json:"queryPath,omitempty"`
// WorkerIds: The 0-based worker ID. If it is empty, all workers'
// GuestAttributes will be returned.
WorkerIds []string `json:"workerIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "QueryPath") 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. "QueryPath") 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:"-"`
}
func (s *GetGuestAttributesRequest) MarshalJSON() ([]byte, error)
GetGuestAttributesResponse: Response for GetGuestAttributes.
type GetGuestAttributesResponse struct {
// GuestAttributes: The guest attributes for the TPU workers.
GuestAttributes []*GuestAttributes `json:"guestAttributes,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "GuestAttributes") 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. "GuestAttributes") 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:"-"`
}
func (s *GetGuestAttributesResponse) MarshalJSON() ([]byte, error)
Guaranteed: Guaranteed tier definition.
type Guaranteed struct {
// MinDuration: Optional. Defines the minimum duration of the guarantee. If
// specified, the requested resources will only be provisioned if they can be
// allocated for at least the given duration.
MinDuration string `json:"minDuration,omitempty"`
// Reserved: Optional. Specifies the request should be scheduled on reserved
// capacity.
Reserved bool `json:"reserved,omitempty"`
// ForceSendFields is a list of field names (e.g. "MinDuration") 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. "MinDuration") 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:"-"`
}
func (s *Guaranteed) MarshalJSON() ([]byte, error)
GuestAttributes: A guest attributes.
type GuestAttributes struct {
// QueryPath: The path to be queried. This can be the default namespace ('/')
// or a nested namespace ('/\/') or a specified key ('/\/\')
QueryPath string `json:"queryPath,omitempty"`
// QueryValue: The value of the requested queried path.
QueryValue *GuestAttributesValue `json:"queryValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "QueryPath") 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. "QueryPath") 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:"-"`
}
func (s *GuestAttributes) MarshalJSON() ([]byte, error)
GuestAttributesEntry: A guest attributes namespace/key/value entry.
type GuestAttributesEntry struct {
// Key: Key for the guest attribute entry.
Key string `json:"key,omitempty"`
// Namespace: Namespace for the guest attribute entry.
Namespace string `json:"namespace,omitempty"`
// Value: Value for the guest attribute entry.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") 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. "Key") 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:"-"`
}
func (s *GuestAttributesEntry) MarshalJSON() ([]byte, error)
GuestAttributesValue: Array of guest attribute namespace/key/value tuples.
type GuestAttributesValue struct {
// Items: The list of guest attributes entries.
Items []*GuestAttributesEntry `json:"items,omitempty"`
// ForceSendFields is a list of field names (e.g. "Items") 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. "Items") 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:"-"`
}
func (s *GuestAttributesValue) MarshalJSON() ([]byte, error)
Interval: Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
type Interval struct {
// EndTime: Optional. Exclusive end of the interval. If specified, a Timestamp
// matching this interval will have to be before the end.
EndTime string `json:"endTime,omitempty"`
// StartTime: Optional. Inclusive start of the interval. If specified, a
// Timestamp matching this interval will have to be the same or after the
// start.
StartTime string `json:"startTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"`
}
func (s *Interval) MarshalJSON() ([]byte, error)
ListAcceleratorTypesResponse: Response for ListAcceleratorTypes.
type ListAcceleratorTypesResponse struct {
// AcceleratorTypes: The listed nodes.
AcceleratorTypes []*AcceleratorType `json:"acceleratorTypes,omitempty"`
// NextPageToken: The next page token or empty if none.
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. "AcceleratorTypes") 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. "AcceleratorTypes") 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:"-"`
}
func (s *ListAcceleratorTypesResponse) MarshalJSON() ([]byte, error)
ListLocationsResponse: The response message for Locations.ListLocations.
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:"-"`
}
func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)
ListNodesResponse: Response for ListNodes.
type ListNodesResponse struct {
// NextPageToken: The next page token or empty if none.
NextPageToken string `json:"nextPageToken,omitempty"`
// Nodes: The listed nodes.
Nodes []*Node `json:"nodes,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. "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:"-"`
}
func (s *ListNodesResponse) MarshalJSON() ([]byte, error)
ListOperationsResponse: The response message for Operations.ListOperations.
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:"-"`
}
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
ListQueuedResourcesResponse: Response for ListQueuedResources.
type ListQueuedResourcesResponse struct {
// NextPageToken: The next page token or empty if none.
NextPageToken string `json:"nextPageToken,omitempty"`
// QueuedResources: The listed queued resources.
QueuedResources []*QueuedResource `json:"queuedResources,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. "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:"-"`
}
func (s *ListQueuedResourcesResponse) MarshalJSON() ([]byte, error)
ListReservationsResponse: Response for ListReservations.
type ListReservationsResponse struct {
// NextPageToken: The next page token or empty if none.
NextPageToken string `json:"nextPageToken,omitempty"`
// Reservations: The listed reservations.
Reservations []*Reservation `json:"reservations,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:"-"`
}
func (s *ListReservationsResponse) MarshalJSON() ([]byte, error)
ListRuntimeVersionsResponse: Response for ListRuntimeVersions.
type ListRuntimeVersionsResponse struct {
// NextPageToken: The next page token or empty if none.
NextPageToken string `json:"nextPageToken,omitempty"`
// RuntimeVersions: The listed nodes.
RuntimeVersions []*RuntimeVersion `json:"runtimeVersions,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. "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:"-"`
}
func (s *ListRuntimeVersionsResponse) MarshalJSON() ([]byte, error)
Location: A resource that represents a Google Cloud 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:"-"`
}
func (s *Location) MarshalJSON() ([]byte, error)
MultiNodeParams: Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params.
type MultiNodeParams struct {
// NodeCount: Required. Number of nodes with this spec. The system will attempt
// to provison "node_count" nodes as part of the request. This needs to be > 1.
NodeCount int64 `json:"nodeCount,omitempty"`
// NodeIdPrefix: Prefix of node_ids in case of multi-node request Should follow
// the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and
// node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1",
// "np-2". If this field is not provided we use queued_resource_id as the
// node_id_prefix.
NodeIdPrefix string `json:"nodeIdPrefix,omitempty"`
// ForceSendFields is a list of field names (e.g. "NodeCount") 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. "NodeCount") 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:"-"`
}
func (s *MultiNodeParams) MarshalJSON() ([]byte, error)
NetworkConfig: Network related configurations.
type NetworkConfig struct {
// CanIpForward: Allows the TPU node to send and receive packets with
// non-matching destination or source IPs. This is required if you plan to use
// the TPU workers to forward routes.
CanIpForward bool `json:"canIpForward,omitempty"`
// EnableExternalIps: Indicates that external IP addresses would be associated
// with the TPU workers. If set to false, the specified subnetwork or network
// should have Private Google Access enabled.
EnableExternalIps bool `json:"enableExternalIps,omitempty"`
// Network: The name of the network for the TPU node. It must be a preexisting
// Google Compute Engine network. If none is provided, "default" will be used.
Network string `json:"network,omitempty"`
// QueueCount: Optional. Specifies networking queue count for TPU VM instance's
// network interface.
QueueCount int64 `json:"queueCount,omitempty"`
// Subnetwork: The name of the subnetwork for the TPU node. It must be a
// preexisting Google Compute Engine subnetwork. If none is provided, "default"
// will be used.
Subnetwork string `json:"subnetwork,omitempty"`
// ForceSendFields is a list of field names (e.g. "CanIpForward") 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. "CanIpForward") 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:"-"`
}
func (s *NetworkConfig) MarshalJSON() ([]byte, error)
NetworkEndpoint: A network endpoint over which a TPU worker can be reached.
type NetworkEndpoint struct {
// AccessConfig: The access config for the TPU worker.
AccessConfig *AccessConfig `json:"accessConfig,omitempty"`
// IpAddress: The internal IP address of this network endpoint.
IpAddress string `json:"ipAddress,omitempty"`
// Port: The port of this network endpoint.
Port int64 `json:"port,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccessConfig") 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. "AccessConfig") 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:"-"`
}
func (s *NetworkEndpoint) MarshalJSON() ([]byte, error)
Node: A TPU instance.
type Node struct {
// AcceleratorConfig: The AccleratorConfig for the TPU Node.
AcceleratorConfig *AcceleratorConfig `json:"acceleratorConfig,omitempty"`
// AcceleratorType: The type of hardware accelerators associated with this
// node.
AcceleratorType string `json:"acceleratorType,omitempty"`
// ApiVersion: Output only. The API version that created this Node.
//
// Possible values:
// "API_VERSION_UNSPECIFIED" - API version is unknown.
// "V1_ALPHA1" - TPU API V1Alpha1 version.
// "V1" - TPU API V1 version.
// "V2_ALPHA1" - TPU API V2Alpha1 version.
ApiVersion string `json:"apiVersion,omitempty"`
// AutocheckpointEnabled: Optional. Whether Autocheckpoint is enabled.
AutocheckpointEnabled bool `json:"autocheckpointEnabled,omitempty"`
// BootDiskConfig: Optional. Boot disk configuration.
BootDiskConfig *BootDiskConfig `json:"bootDiskConfig,omitempty"`
// CidrBlock: The CIDR block that the TPU node will use when selecting an IP
// address. This CIDR block must be a /29 block; the Compute Engine networks
// API forbids a smaller block, and using a larger block would be wasteful (a
// node can only consume one IP address). Errors will occur if the CIDR block
// has already been used for a currently existing TPU node, the CIDR block
// conflicts with any subnetworks in the user's provided network, or the
// provided network is peered with another network that is using that CIDR
// block.
CidrBlock string `json:"cidrBlock,omitempty"`
// CreateTime: Output only. The time when the node was created.
CreateTime string `json:"createTime,omitempty"`
// DataDisks: The additional data disks for the Node.
DataDisks []*AttachedDisk `json:"dataDisks,omitempty"`
// Description: The user-supplied description of the TPU. Maximum of 512
// characters.
Description string `json:"description,omitempty"`
// Health: The health status of the TPU node.
//
// Possible values:
// "HEALTH_UNSPECIFIED" - Health status is unknown: not initialized or failed
// to retrieve.
// "HEALTHY" - The resource is healthy.
// "TIMEOUT" - The resource is unresponsive.
// "UNHEALTHY_TENSORFLOW" - The in-guest ML stack is unhealthy.
// "UNHEALTHY_MAINTENANCE" - The node is under maintenance/priority boost
// caused rescheduling and will resume running once rescheduled.
Health string `json:"health,omitempty"`
// HealthDescription: Output only. If this field is populated, it contains a
// description of why the TPU Node is unhealthy.
HealthDescription string `json:"healthDescription,omitempty"`
// Id: Output only. The unique identifier for the TPU Node.
Id int64 `json:"id,omitempty,string"`
// Labels: Resource labels to represent user-provided metadata.
Labels map[string]string `json:"labels,omitempty"`
// Metadata: Custom metadata to apply to the TPU Node. Can set startup-script
// and shutdown-script
Metadata map[string]string `json:"metadata,omitempty"`
// MultisliceNode: Output only. Whether the Node belongs to a Multislice group.
MultisliceNode bool `json:"multisliceNode,omitempty"`
// Name: Output only. Immutable. The name of the TPU.
Name string `json:"name,omitempty"`
// NetworkConfig: Network configurations for the TPU node.
NetworkConfig *NetworkConfig `json:"networkConfig,omitempty"`
// NetworkEndpoints: Output only. The network endpoints where TPU workers can
// be accessed and sent work. It is recommended that runtime clients of the
// node reach out to the 0th entry in this map first.
NetworkEndpoints []*NetworkEndpoint `json:"networkEndpoints,omitempty"`
// QueuedResource: Output only. The qualified name of the QueuedResource that
// requested this Node.
QueuedResource string `json:"queuedResource,omitempty"`
// RuntimeVersion: Required. The runtime version running in the Node.
RuntimeVersion string `json:"runtimeVersion,omitempty"`
// SchedulingConfig: The scheduling options for this node.
SchedulingConfig *SchedulingConfig `json:"schedulingConfig,omitempty"`
// ServiceAccount: The Google Cloud Platform Service Account to be used by the
// TPU node VMs. If None is specified, the default compute service account will
// be used.
ServiceAccount *ServiceAccount `json:"serviceAccount,omitempty"`
// ShieldedInstanceConfig: Shielded Instance options.
ShieldedInstanceConfig *ShieldedInstanceConfig `json:"shieldedInstanceConfig,omitempty"`
// State: Output only. The current state for the TPU Node.
//
// Possible values:
// "STATE_UNSPECIFIED" - TPU node state is not known/set.
// "CREATING" - TPU node is being created.
// "READY" - TPU node has been created.
// "RESTARTING" - TPU node is restarting.
// "REIMAGING" - TPU node is undergoing reimaging.
// "DELETING" - TPU node is being deleted.
// "REPAIRING" - TPU node is being repaired and may be unusable. Details can
// be found in the 'help_description' field.
// "STOPPED" - TPU node is stopped.
// "STOPPING" - TPU node is currently stopping.
// "STARTING" - TPU node is currently starting.
// "PREEMPTED" - TPU node has been preempted. Only applies to Preemptible TPU
// Nodes.
// "TERMINATED" - TPU node has been terminated due to maintenance or has
// reached the end of its life cycle (for preemptible nodes).
// "HIDING" - TPU node is currently hiding.
// "HIDDEN" - TPU node has been hidden.
// "UNHIDING" - TPU node is currently unhiding.
State string `json:"state,omitempty"`
// Symptoms: Output only. The Symptoms that have occurred to the TPU Node.
Symptoms []*Symptom `json:"symptoms,omitempty"`
// Tags: Tags to apply to the TPU Node. Tags are used to identify valid sources
// or targets for network firewalls.
Tags []string `json:"tags,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AcceleratorConfig") 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. "AcceleratorConfig") 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:"-"`
}
func (s *Node) MarshalJSON() ([]byte, error)
NodeSpec: Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created.
type NodeSpec struct {
// MultiNodeParams: Optional. Fields to specify in case of multi-node request.
MultiNodeParams *MultiNodeParams `json:"multiNodeParams,omitempty"`
// Node: Required. The node.
Node *Node `json:"node,omitempty"`
// NodeId: The unqualified resource name. Should follow the
// `^[A-Za-z0-9_.~+%-]+$` regex format. This is only specified when requesting
// a single node. In case of multi-node requests, multi_node_params must be
// populated instead. It's an error to specify both node_id and
// multi_node_params.
NodeId string `json:"nodeId,omitempty"`
// Parent: Required. The parent resource name.
Parent string `json:"parent,omitempty"`
// ForceSendFields is a list of field names (e.g. "MultiNodeParams") 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. "MultiNodeParams") 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:"-"`
}
func (s *NodeSpec) MarshalJSON() ([]byte, error)
Operation: This resource represents a long-running operation that is the result of a network API call.
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:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error)
OperationMetadata: Metadata describing an Operation
type OperationMetadata struct {
// ApiVersion: API version.
ApiVersion string `json:"apiVersion,omitempty"`
// CancelRequested: Specifies if cancellation was requested for the operation.
CancelRequested bool `json:"cancelRequested,omitempty"`
// CreateTime: The time the operation was created.
CreateTime string `json:"createTime,omitempty"`
// EndTime: The time the operation finished running.
EndTime string `json:"endTime,omitempty"`
// StatusDetail: Human-readable status of the operation, if any.
StatusDetail string `json:"statusDetail,omitempty"`
// Target: Target of the operation - for example
// projects/project-1/connectivityTests/test-1
Target string `json:"target,omitempty"`
// Verb: 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:"-"`
}
func (s *OperationMetadata) MarshalJSON() ([]byte, error)
type ProjectsLocationsAcceleratorTypesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsAcceleratorTypesGetCall) Context(ctx context.Context) *ProjectsLocationsAcceleratorTypesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsAcceleratorTypesGetCall) Do(opts ...googleapi.CallOption) (*AcceleratorType, error)
Do executes the "tpu.projects.locations.acceleratorTypes.get" call. Any non-2xx status code is an error. Response headers are in either *AcceleratorType.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 (c *ProjectsLocationsAcceleratorTypesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsAcceleratorTypesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsAcceleratorTypesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsAcceleratorTypesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsAcceleratorTypesGetCall
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 ProjectsLocationsAcceleratorTypesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsAcceleratorTypesListCall) Context(ctx context.Context) *ProjectsLocationsAcceleratorTypesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsAcceleratorTypesListCall) Do(opts ...googleapi.CallOption) (*ListAcceleratorTypesResponse, error)
Do executes the "tpu.projects.locations.acceleratorTypes.list" call. Any non-2xx status code is an error. Response headers are in either *ListAcceleratorTypesResponse.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 (c *ProjectsLocationsAcceleratorTypesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsAcceleratorTypesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsAcceleratorTypesListCall) Filter(filter string) *ProjectsLocationsAcceleratorTypesListCall
Filter sets the optional parameter "filter": List filter.
func (c *ProjectsLocationsAcceleratorTypesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsAcceleratorTypesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsAcceleratorTypesListCall
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 (c *ProjectsLocationsAcceleratorTypesListCall) OrderBy(orderBy string) *ProjectsLocationsAcceleratorTypesListCall
OrderBy sets the optional parameter "orderBy": Sort results.
func (c *ProjectsLocationsAcceleratorTypesListCall) PageSize(pageSize int64) *ProjectsLocationsAcceleratorTypesListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return.
func (c *ProjectsLocationsAcceleratorTypesListCall) PageToken(pageToken string) *ProjectsLocationsAcceleratorTypesListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *ProjectsLocationsAcceleratorTypesListCall) Pages(ctx context.Context, f func(*ListAcceleratorTypesResponse) error) error
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 ProjectsLocationsAcceleratorTypesService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsAcceleratorTypesService(s *Service) *ProjectsLocationsAcceleratorTypesService
func (r *ProjectsLocationsAcceleratorTypesService) Get(name string) *ProjectsLocationsAcceleratorTypesGetCall
Get: Gets AcceleratorType.
- name: The resource name.
func (r *ProjectsLocationsAcceleratorTypesService) List(parent string) *ProjectsLocationsAcceleratorTypesListCall
List: Lists accelerator types supported by this API.
- parent: The parent resource name.
type ProjectsLocationsGenerateServiceIdentityCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsGenerateServiceIdentityCall) Context(ctx context.Context) *ProjectsLocationsGenerateServiceIdentityCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsGenerateServiceIdentityCall) Do(opts ...googleapi.CallOption) (*GenerateServiceIdentityResponse, error)
Do executes the "tpu.projects.locations.generateServiceIdentity" call. Any non-2xx status code is an error. Response headers are in either *GenerateServiceIdentityResponse.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 (c *ProjectsLocationsGenerateServiceIdentityCall) Fields(s ...googleapi.Field) *ProjectsLocationsGenerateServiceIdentityCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsGenerateServiceIdentityCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
Do executes the "tpu.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 (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
Do executes the "tpu.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 (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
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 (c *ProjectsLocationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.
func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
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 (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
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 ProjectsLocationsNodesCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesCreateCall) Context(ctx context.Context) *ProjectsLocationsNodesCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.nodes.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 (c *ProjectsLocationsNodesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsNodesCreateCall) NodeId(nodeId string) *ProjectsLocationsNodesCreateCall
NodeId sets the optional parameter "nodeId": The unqualified resource name.
func (c *ProjectsLocationsNodesCreateCall) RequestId(requestId string) *ProjectsLocationsNodesCreateCall
RequestId sets the optional parameter "requestId": Idempotent request UUID.
type ProjectsLocationsNodesDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesDeleteCall) Context(ctx context.Context) *ProjectsLocationsNodesDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.nodes.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 (c *ProjectsLocationsNodesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsNodesDeleteCall) RequestId(requestId string) *ProjectsLocationsNodesDeleteCall
RequestId sets the optional parameter "requestId": Idempotent request UUID.
type ProjectsLocationsNodesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesGetCall) Context(ctx context.Context) *ProjectsLocationsNodesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesGetCall) Do(opts ...googleapi.CallOption) (*Node, error)
Do executes the "tpu.projects.locations.nodes.get" call. Any non-2xx status code is an error. Response headers are in either *Node.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 (c *ProjectsLocationsNodesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsNodesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsNodesGetCall
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 ProjectsLocationsNodesGetGuestAttributesCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesGetGuestAttributesCall) Context(ctx context.Context) *ProjectsLocationsNodesGetGuestAttributesCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesGetGuestAttributesCall) Do(opts ...googleapi.CallOption) (*GetGuestAttributesResponse, error)
Do executes the "tpu.projects.locations.nodes.getGuestAttributes" call. Any non-2xx status code is an error. Response headers are in either *GetGuestAttributesResponse.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 (c *ProjectsLocationsNodesGetGuestAttributesCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesGetGuestAttributesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesGetGuestAttributesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsNodesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesListCall) Context(ctx context.Context) *ProjectsLocationsNodesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesListCall) Do(opts ...googleapi.CallOption) (*ListNodesResponse, error)
Do executes the "tpu.projects.locations.nodes.list" call. Any non-2xx status code is an error. Response headers are in either *ListNodesResponse.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 (c *ProjectsLocationsNodesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsNodesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsNodesListCall
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 (c *ProjectsLocationsNodesListCall) PageSize(pageSize int64) *ProjectsLocationsNodesListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return.
func (c *ProjectsLocationsNodesListCall) PageToken(pageToken string) *ProjectsLocationsNodesListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *ProjectsLocationsNodesListCall) Pages(ctx context.Context, f func(*ListNodesResponse) error) error
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 ProjectsLocationsNodesPatchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesPatchCall) Context(ctx context.Context) *ProjectsLocationsNodesPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.nodes.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 (c *ProjectsLocationsNodesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsNodesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsNodesPatchCall
UpdateMask sets the optional parameter "updateMask": Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].
type ProjectsLocationsNodesService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsNodesService(s *Service) *ProjectsLocationsNodesService
func (r *ProjectsLocationsNodesService) Create(parent string, node *Node) *ProjectsLocationsNodesCreateCall
Create: Creates a node.
- parent: The parent resource name.
func (r *ProjectsLocationsNodesService) Delete(name string) *ProjectsLocationsNodesDeleteCall
Delete: Deletes a node.
- name: The resource name.
func (r *ProjectsLocationsNodesService) Get(name string) *ProjectsLocationsNodesGetCall
Get: Gets the details of a node.
- name: The resource name.
func (r *ProjectsLocationsNodesService) GetGuestAttributes(name string, getguestattributesrequest *GetGuestAttributesRequest) *ProjectsLocationsNodesGetGuestAttributesCall
GetGuestAttributes: Retrieves the guest attributes for the node.
- name: The resource name.
func (r *ProjectsLocationsNodesService) List(parent string) *ProjectsLocationsNodesListCall
List: Lists nodes.
- parent: The parent resource name.
func (r *ProjectsLocationsNodesService) Patch(name string, node *Node) *ProjectsLocationsNodesPatchCall
Patch: Updates the configurations of a node.
- name: Output only. Immutable. The name of the TPU.
func (r *ProjectsLocationsNodesService) SimulateMaintenanceEvent(name string, simulatemaintenanceeventrequest *SimulateMaintenanceEventRequest) *ProjectsLocationsNodesSimulateMaintenanceEventCall
SimulateMaintenanceEvent: Simulates a maintenance event.
- name: The resource name.
func (r *ProjectsLocationsNodesService) Start(name string, startnoderequest *StartNodeRequest) *ProjectsLocationsNodesStartCall
Start: Starts a node.
- name: The resource name.
func (r *ProjectsLocationsNodesService) Stop(name string, stopnoderequest *StopNodeRequest) *ProjectsLocationsNodesStopCall
Stop: Stops a node. This operation is only available with single TPU nodes.
- name: The resource name.
type ProjectsLocationsNodesSimulateMaintenanceEventCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesSimulateMaintenanceEventCall) Context(ctx context.Context) *ProjectsLocationsNodesSimulateMaintenanceEventCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesSimulateMaintenanceEventCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.nodes.simulateMaintenanceEvent" 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 (c *ProjectsLocationsNodesSimulateMaintenanceEventCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesSimulateMaintenanceEventCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesSimulateMaintenanceEventCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsNodesStartCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesStartCall) Context(ctx context.Context) *ProjectsLocationsNodesStartCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesStartCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.nodes.start" 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 (c *ProjectsLocationsNodesStartCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesStartCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesStartCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsNodesStopCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsNodesStopCall) Context(ctx context.Context) *ProjectsLocationsNodesStopCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsNodesStopCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.nodes.stop" 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 (c *ProjectsLocationsNodesStopCall) Fields(s ...googleapi.Field) *ProjectsLocationsNodesStopCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsNodesStopCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsOperationsCancelCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "tpu.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsOperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "tpu.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.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 (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "tpu.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 (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (c *ProjectsLocationsOperationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
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 (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
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 struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (r *ProjectsLocationsOperationsService) Cancel(name string) *ProjectsLocationsOperationsCancelCall
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 (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
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 (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
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 (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
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 ProjectsLocationsQueuedResourcesCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsQueuedResourcesCreateCall) Context(ctx context.Context) *ProjectsLocationsQueuedResourcesCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsQueuedResourcesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.queuedResources.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 (c *ProjectsLocationsQueuedResourcesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuedResourcesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsQueuedResourcesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsQueuedResourcesCreateCall) QueuedResourceId(queuedResourceId string) *ProjectsLocationsQueuedResourcesCreateCall
QueuedResourceId sets the optional parameter "queuedResourceId": The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.
func (c *ProjectsLocationsQueuedResourcesCreateCall) RequestId(requestId string) *ProjectsLocationsQueuedResourcesCreateCall
RequestId sets the optional parameter "requestId": Idempotent request UUID.
type ProjectsLocationsQueuedResourcesDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsQueuedResourcesDeleteCall) Context(ctx context.Context) *ProjectsLocationsQueuedResourcesDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsQueuedResourcesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.queuedResources.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 (c *ProjectsLocationsQueuedResourcesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuedResourcesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsQueuedResourcesDeleteCall) Force(force bool) *ProjectsLocationsQueuedResourcesDeleteCall
Force sets the optional parameter "force": If set to true, all running nodes belonging to this queued resource will be deleted first and then the queued resource will be deleted. Otherwise (i.e. force=false), the queued resource will only be deleted if its nodes have already been deleted or the queued resource is in the ACCEPTED, FAILED, or SUSPENDED state.
func (c *ProjectsLocationsQueuedResourcesDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsQueuedResourcesDeleteCall) RequestId(requestId string) *ProjectsLocationsQueuedResourcesDeleteCall
RequestId sets the optional parameter "requestId": Idempotent request UUID.
type ProjectsLocationsQueuedResourcesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsQueuedResourcesGetCall) Context(ctx context.Context) *ProjectsLocationsQueuedResourcesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsQueuedResourcesGetCall) Do(opts ...googleapi.CallOption) (*QueuedResource, error)
Do executes the "tpu.projects.locations.queuedResources.get" call. Any non-2xx status code is an error. Response headers are in either *QueuedResource.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 (c *ProjectsLocationsQueuedResourcesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuedResourcesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsQueuedResourcesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsQueuedResourcesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueuedResourcesGetCall
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 ProjectsLocationsQueuedResourcesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsQueuedResourcesListCall) Context(ctx context.Context) *ProjectsLocationsQueuedResourcesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsQueuedResourcesListCall) Do(opts ...googleapi.CallOption) (*ListQueuedResourcesResponse, error)
Do executes the "tpu.projects.locations.queuedResources.list" call. Any non-2xx status code is an error. Response headers are in either *ListQueuedResourcesResponse.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 (c *ProjectsLocationsQueuedResourcesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuedResourcesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsQueuedResourcesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsQueuedResourcesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueuedResourcesListCall
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 (c *ProjectsLocationsQueuedResourcesListCall) PageSize(pageSize int64) *ProjectsLocationsQueuedResourcesListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return.
func (c *ProjectsLocationsQueuedResourcesListCall) PageToken(pageToken string) *ProjectsLocationsQueuedResourcesListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *ProjectsLocationsQueuedResourcesListCall) Pages(ctx context.Context, f func(*ListQueuedResourcesResponse) error) error
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 ProjectsLocationsQueuedResourcesResetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsQueuedResourcesResetCall) Context(ctx context.Context) *ProjectsLocationsQueuedResourcesResetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsQueuedResourcesResetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "tpu.projects.locations.queuedResources.reset" 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 (c *ProjectsLocationsQueuedResourcesResetCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuedResourcesResetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsQueuedResourcesResetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsQueuedResourcesService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsQueuedResourcesService(s *Service) *ProjectsLocationsQueuedResourcesService
func (r *ProjectsLocationsQueuedResourcesService) Create(parent string, queuedresource *QueuedResource) *ProjectsLocationsQueuedResourcesCreateCall
Create: Creates a QueuedResource TPU instance.
- parent: The parent resource name.
func (r *ProjectsLocationsQueuedResourcesService) Delete(name string) *ProjectsLocationsQueuedResourcesDeleteCall
Delete: Deletes a QueuedResource TPU instance.
- name: The resource name.
func (r *ProjectsLocationsQueuedResourcesService) Get(name string) *ProjectsLocationsQueuedResourcesGetCall
Get: Gets details of a queued resource.
- name: The resource name.
func (r *ProjectsLocationsQueuedResourcesService) List(parent string) *ProjectsLocationsQueuedResourcesListCall
List: Lists queued resources.
- parent: The parent resource name.
func (r *ProjectsLocationsQueuedResourcesService) Reset(name string, resetqueuedresourcerequest *ResetQueuedResourceRequest) *ProjectsLocationsQueuedResourcesResetCall
Reset: Resets a QueuedResource TPU instance
- name: The name of the queued resource.
type ProjectsLocationsReservationsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsReservationsListCall) Context(ctx context.Context) *ProjectsLocationsReservationsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsReservationsListCall) Do(opts ...googleapi.CallOption) (*ListReservationsResponse, error)
Do executes the "tpu.projects.locations.reservations.list" call. Any non-2xx status code is an error. Response headers are in either *ListReservationsResponse.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 (c *ProjectsLocationsReservationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsReservationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsReservationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsReservationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsReservationsListCall
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 (c *ProjectsLocationsReservationsListCall) PageSize(pageSize int64) *ProjectsLocationsReservationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return.
func (c *ProjectsLocationsReservationsListCall) PageToken(pageToken string) *ProjectsLocationsReservationsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *ProjectsLocationsReservationsListCall) Pages(ctx context.Context, f func(*ListReservationsResponse) error) error
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 ProjectsLocationsReservationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsReservationsService(s *Service) *ProjectsLocationsReservationsService
func (r *ProjectsLocationsReservationsService) List(parent string) *ProjectsLocationsReservationsListCall
List: Retrieves the reservations for the given project in the given location.
- parent: The parent for reservations.
type ProjectsLocationsRuntimeVersionsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsRuntimeVersionsGetCall) Context(ctx context.Context) *ProjectsLocationsRuntimeVersionsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsRuntimeVersionsGetCall) Do(opts ...googleapi.CallOption) (*RuntimeVersion, error)
Do executes the "tpu.projects.locations.runtimeVersions.get" call. Any non-2xx status code is an error. Response headers are in either *RuntimeVersion.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 (c *ProjectsLocationsRuntimeVersionsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimeVersionsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsRuntimeVersionsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsRuntimeVersionsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsRuntimeVersionsGetCall
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 ProjectsLocationsRuntimeVersionsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsRuntimeVersionsListCall) Context(ctx context.Context) *ProjectsLocationsRuntimeVersionsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsRuntimeVersionsListCall) Do(opts ...googleapi.CallOption) (*ListRuntimeVersionsResponse, error)
Do executes the "tpu.projects.locations.runtimeVersions.list" call. Any non-2xx status code is an error. Response headers are in either *ListRuntimeVersionsResponse.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 (c *ProjectsLocationsRuntimeVersionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimeVersionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsRuntimeVersionsListCall) Filter(filter string) *ProjectsLocationsRuntimeVersionsListCall
Filter sets the optional parameter "filter": List filter.
func (c *ProjectsLocationsRuntimeVersionsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsRuntimeVersionsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsRuntimeVersionsListCall
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 (c *ProjectsLocationsRuntimeVersionsListCall) OrderBy(orderBy string) *ProjectsLocationsRuntimeVersionsListCall
OrderBy sets the optional parameter "orderBy": Sort results.
func (c *ProjectsLocationsRuntimeVersionsListCall) PageSize(pageSize int64) *ProjectsLocationsRuntimeVersionsListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return.
func (c *ProjectsLocationsRuntimeVersionsListCall) PageToken(pageToken string) *ProjectsLocationsRuntimeVersionsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *ProjectsLocationsRuntimeVersionsListCall) Pages(ctx context.Context, f func(*ListRuntimeVersionsResponse) error) error
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 ProjectsLocationsRuntimeVersionsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsRuntimeVersionsService(s *Service) *ProjectsLocationsRuntimeVersionsService
func (r *ProjectsLocationsRuntimeVersionsService) Get(name string) *ProjectsLocationsRuntimeVersionsGetCall
Get: Gets a runtime version.
- name: The resource name.
func (r *ProjectsLocationsRuntimeVersionsService) List(parent string) *ProjectsLocationsRuntimeVersionsListCall
List: Lists runtime versions supported by this API.
- parent: The parent resource name.
type ProjectsLocationsService struct {
AcceleratorTypes *ProjectsLocationsAcceleratorTypesService
Nodes *ProjectsLocationsNodesService
Operations *ProjectsLocationsOperationsService
QueuedResources *ProjectsLocationsQueuedResourcesService
Reservations *ProjectsLocationsReservationsService
RuntimeVersions *ProjectsLocationsRuntimeVersionsService
// contains filtered or unexported fields
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (r *ProjectsLocationsService) GenerateServiceIdentity(parent string, generateserviceidentityrequest *GenerateServiceIdentityRequest) *ProjectsLocationsGenerateServiceIdentityCall
GenerateServiceIdentity: Generates the Cloud TPU service identity for the project.
- parent: The parent resource name.
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall
Get: Gets information about a location.
- name: Resource name for the location.
func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall
List: Lists information about the supported locations for this service.
- name: The resource that owns the locations collection, if applicable.
type ProjectsService struct {
Locations *ProjectsLocationsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
ProvisioningData: Further data for the provisioning state.
type ProvisioningData struct {
}
QueuedResource: A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.
type QueuedResource struct {
// BestEffort: The BestEffort tier.
BestEffort *BestEffort `json:"bestEffort,omitempty"`
// CreateTime: Output only. The time when the QueuedResource was created.
CreateTime string `json:"createTime,omitempty"`
// Guaranteed: The Guaranteed tier.
Guaranteed *Guaranteed `json:"guaranteed,omitempty"`
// Name: Output only. Immutable. The name of the QueuedResource.
Name string `json:"name,omitempty"`
// QueueingPolicy: The queueing policy of the QueuedRequest.
QueueingPolicy *QueueingPolicy `json:"queueingPolicy,omitempty"`
// ReservationName: Name of the reservation in which the resource should be
// provisioned. Format:
// projects/{project}/locations/{zone}/reservations/{reservation}
ReservationName string `json:"reservationName,omitempty"`
// Spot: Optional. The Spot tier.
Spot *Spot `json:"spot,omitempty"`
// State: Output only. State of the QueuedResource request.
State *QueuedResourceState `json:"state,omitempty"`
// Tpu: Defines a TPU resource.
Tpu *Tpu `json:"tpu,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "BestEffort") 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. "BestEffort") 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:"-"`
}
func (s *QueuedResource) MarshalJSON() ([]byte, error)
QueuedResourceState: QueuedResourceState defines the details of the QueuedResource request.
type QueuedResourceState struct {
// AcceptedData: Further data for the accepted state.
AcceptedData *AcceptedData `json:"acceptedData,omitempty"`
// ActiveData: Further data for the active state.
ActiveData *ActiveData `json:"activeData,omitempty"`
// CreatingData: Further data for the creating state.
CreatingData *CreatingData `json:"creatingData,omitempty"`
// DeletingData: Further data for the deleting state.
DeletingData *DeletingData `json:"deletingData,omitempty"`
// FailedData: Further data for the failed state.
FailedData *FailedData `json:"failedData,omitempty"`
// ProvisioningData: Further data for the provisioning state.
ProvisioningData *ProvisioningData `json:"provisioningData,omitempty"`
// State: State of the QueuedResource request.
//
// Possible values:
// "STATE_UNSPECIFIED" - State of the QueuedResource request is not
// known/set.
// "CREATING" - The QueuedResource request has been received. We're still
// working on determining if we will be able to honor this request.
// "ACCEPTED" - The QueuedResource request has passed initial
// validation/admission control and has been persisted in the queue.
// "PROVISIONING" - The QueuedResource request has been selected. The
// associated resources are currently being provisioned (or very soon will
// begin provisioning).
// "FAILED" - The request could not be completed. This may be due to some
// late-discovered problem with the request itself, or due to unavailability of
// resources within the constraints of the request (e.g., the 'valid until'
// start timing constraint expired).
// "DELETING" - The QueuedResource is being deleted.
// "ACTIVE" - The resources specified in the QueuedResource request have been
// provisioned and are ready for use by the end-user/consumer.
// "SUSPENDING" - The resources specified in the QueuedResource request are
// being deleted. This may have been initiated by the user, or the Cloud TPU
// service. Inspect the state data for more details.
// "SUSPENDED" - The resources specified in the QueuedResource request have
// been deleted.
// "WAITING_FOR_RESOURCES" - The QueuedResource request has passed initial
// validation and has been persisted in the queue. It will remain in this state
// until there are sufficient free resources to begin provisioning your
// request. Wait times will vary significantly depending on demand levels. When
// demand is high, not all requests can be immediately provisioned. If you need
// more reliable obtainability of TPUs consider purchasing a reservation. To
// put a limit on how long you are willing to wait, use [timing
// constraints](https://cloud.google.com/tpu/docs/queued-resources#request_a_que
// ued_resource_before_a_specified_time).
State string `json:"state,omitempty"`
// StateInitiator: Output only. The initiator of the QueuedResources's current
// state. Used to indicate whether the SUSPENDING/SUSPENDED state was initiated
// by the user or the service.
//
// Possible values:
// "STATE_INITIATOR_UNSPECIFIED" - The state initiator is unspecified.
// "USER" - The current QueuedResource state was initiated by the user.
// "SERVICE" - The current QueuedResource state was initiated by the service.
StateInitiator string `json:"stateInitiator,omitempty"`
// SuspendedData: Further data for the suspended state.
SuspendedData *SuspendedData `json:"suspendedData,omitempty"`
// SuspendingData: Further data for the suspending state.
SuspendingData *SuspendingData `json:"suspendingData,omitempty"`
// ForceSendFields is a list of field names (e.g. "AcceptedData") 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. "AcceptedData") 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:"-"`
}
func (s *QueuedResourceState) MarshalJSON() ([]byte, error)
QueueingPolicy: Defines the policy of the QueuedRequest.
type QueueingPolicy struct {
// ValidAfterDuration: A relative time after which resources may be created.
ValidAfterDuration string `json:"validAfterDuration,omitempty"`
// ValidAfterTime: An absolute time at which resources may be created.
ValidAfterTime string `json:"validAfterTime,omitempty"`
// ValidInterval: An absolute time interval within which resources may be
// created.
ValidInterval *Interval `json:"validInterval,omitempty"`
// ValidUntilDuration: A relative time after which resources should not be
// created. If the request cannot be fulfilled by this time the request will be
// failed.
ValidUntilDuration string `json:"validUntilDuration,omitempty"`
// ValidUntilTime: An absolute time after which resources should not be
// created. If the request cannot be fulfilled by this time the request will be
// failed.
ValidUntilTime string `json:"validUntilTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "ValidAfterDuration") 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. "ValidAfterDuration") 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:"-"`
}
func (s *QueueingPolicy) MarshalJSON() ([]byte, error)
Reservation: A reservation describes the amount of a resource 'allotted' for a defined period of time.
type Reservation struct {
// Name: The reservation name with the format:
// projects/{projectID}/locations/{location}/reservations/{reservationID}
Name string `json:"name,omitempty"`
Standard *Standard `json:"standard,omitempty"`
// State: Output only. The state of the Reservation.
//
// Possible values:
// "STATE_UNSPECIFIED" - The Reservation state is unspecified.
// "APPROVED" - The Reservation has been approved.
// "PROVISIONING" - The Reservation is being provisioned.
// "ACTIVE" - The Reservation is active.
// "DEPROVISIONING" - The Reservation is being deprovisioned.
// "EXPIRED" - The Reservation is past its end date.
// "FAILED" - The Reservation encountered a failure during mutation.
State string `json:"state,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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:"-"`
}
func (s *Reservation) MarshalJSON() ([]byte, error)
ResetQueuedResourceRequest: Request for ResetQueuedResource.
type ResetQueuedResourceRequest struct {
}
RuntimeVersion: A runtime version that a Node can be configured with.
type RuntimeVersion struct {
// Name: The resource name.
Name string `json:"name,omitempty"`
// Version: The runtime version.
Version string `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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:"-"`
}
func (s *RuntimeVersion) MarshalJSON() ([]byte, error)
SchedulingConfig: Sets the scheduling options for this node.
type SchedulingConfig struct {
// Preemptible: Defines whether the node is preemptible.
Preemptible bool `json:"preemptible,omitempty"`
// Reserved: Whether the node is created under a reservation.
Reserved bool `json:"reserved,omitempty"`
// Spot: Optional. Defines whether the node is Spot VM.
Spot bool `json:"spot,omitempty"`
// ForceSendFields is a list of field names (e.g. "Preemptible") 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. "Preemptible") 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:"-"`
}
func (s *SchedulingConfig) MarshalJSON() ([]byte, error)
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(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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
ServiceAccount: A service account.
type ServiceAccount struct {
// Email: Email address of the service account. If empty, default Compute
// service account will be used.
Email string `json:"email,omitempty"`
// Scope: The list of scopes to be made available for this service account. If
// empty, access to all Cloud APIs will be allowed.
Scope []string `json:"scope,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") 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. "Email") 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:"-"`
}
func (s *ServiceAccount) MarshalJSON() ([]byte, error)
ServiceIdentity: The per-product per-project service identity for Cloud TPU service.
type ServiceIdentity struct {
// Email: The email address of the service identity.
Email string `json:"email,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") 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. "Email") 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:"-"`
}
func (s *ServiceIdentity) MarshalJSON() ([]byte, error)
ShieldedInstanceConfig: A set of Shielded Instance options.
type ShieldedInstanceConfig struct {
// EnableSecureBoot: Defines whether the instance has Secure Boot enabled.
EnableSecureBoot bool `json:"enableSecureBoot,omitempty"`
// ForceSendFields is a list of field names (e.g. "EnableSecureBoot") 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. "EnableSecureBoot") 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:"-"`
}
func (s *ShieldedInstanceConfig) MarshalJSON() ([]byte, error)
SimulateMaintenanceEventRequest: Request for SimulateMaintenanceEvent.
type SimulateMaintenanceEventRequest struct {
// WorkerIds: The 0-based worker ID. If it is empty, worker ID 0 will be
// selected for maintenance event simulation. A maintenance event will only be
// fired on the first specified worker ID. Future implementations may support
// firing on multiple workers.
WorkerIds []string `json:"workerIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "WorkerIds") 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. "WorkerIds") 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:"-"`
}
func (s *SimulateMaintenanceEventRequest) MarshalJSON() ([]byte, error)
Spot: Spot tier definition.
type Spot struct {
}
type Standard struct {
// Possible values:
// "CAPACITY_UNITS_UNSPECIFIED" - The capacity units is not known/set.
// "CORES" - The capacity unit is set to CORES.
// "CHIPS" - The capacity unit is set to CHIPS.
CapacityUnits string `json:"capacityUnits,omitempty"`
// Interval: The start and end time of the reservation.
Interval *Interval `json:"interval,omitempty"`
// ResourceType: The resource type of the reservation.
ResourceType string `json:"resourceType,omitempty"`
// Size: The size of the reservation, in the units specified in the
// 'capacity_units' field.
Size int64 `json:"size,omitempty"`
Usage *Usage `json:"usage,omitempty"`
// ForceSendFields is a list of field names (e.g. "CapacityUnits") 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. "CapacityUnits") 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:"-"`
}
func (s *Standard) MarshalJSON() ([]byte, error)
StartNodeRequest: Request for StartNode.
type StartNodeRequest struct {
}
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).
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:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
StopNodeRequest: Request for StopNode.
type StopNodeRequest struct {
}
SuspendedData: Further data for the suspended state.
type SuspendedData struct {
}
SuspendingData: Further data for the suspending state.
type SuspendingData struct {
}
Symptom: A Symptom instance.
type Symptom struct {
// CreateTime: Timestamp when the Symptom is created.
CreateTime string `json:"createTime,omitempty"`
// Details: Detailed information of the current Symptom.
Details string `json:"details,omitempty"`
// SymptomType: Type of the Symptom.
//
// Possible values:
// "SYMPTOM_TYPE_UNSPECIFIED" - Unspecified symptom.
// "LOW_MEMORY" - TPU VM memory is low.
// "OUT_OF_MEMORY" - TPU runtime is out of memory.
// "EXECUTE_TIMED_OUT" - TPU runtime execution has timed out.
// "MESH_BUILD_FAIL" - TPU runtime fails to construct a mesh that recognizes
// each TPU device's neighbors.
// "HBM_OUT_OF_MEMORY" - TPU HBM is out of memory.
// "PROJECT_ABUSE" - Abusive behaviors have been identified on the current
// project.
SymptomType string `json:"symptomType,omitempty"`
// WorkerId: A string used to uniquely distinguish a worker within a TPU node.
WorkerId string `json:"workerId,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}
func (s *Symptom) MarshalJSON() ([]byte, error)
Tpu: Details of the TPU resource(s) being requested.
type Tpu struct {
// NodeSpec: The TPU node(s) being requested.
NodeSpec []*NodeSpec `json:"nodeSpec,omitempty"`
// ForceSendFields is a list of field names (e.g. "NodeSpec") 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. "NodeSpec") 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:"-"`
}
func (s *Tpu) MarshalJSON() ([]byte, error)
type Usage struct {
// Total: The real-time value of usage within the reservation, with the unit
// specified in field capacity_units.
Total int64 `json:"total,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Total") 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. "Total") 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:"-"`
}
func (s *Usage) MarshalJSON() ([]byte, error)