Package baremetalsolution is an auto-generated package for the Bare Metal Solution API.
Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.
General documentation
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Example usage
To get started with this package, create a client.
ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := baremetalsolution . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := baremetalsolution . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & baremetalsolutionpb . ListInstancesRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ListInstancesRequest. } it := c . ListInstances ( ctx , req ) for { resp , err := it . Next () if err == iterator . Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Inspecting errors
To see examples of how to inspect errors returned by this package please reference [Inspecting errors]( https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors ).
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
ListInstances
[]
gax
.
CallOption
GetInstance
[]
gax
.
CallOption
UpdateInstance
[]
gax
.
CallOption
ResetInstance
[]
gax
.
CallOption
StartInstance
[]
gax
.
CallOption
StopInstance
[]
gax
.
CallOption
DetachLun
[]
gax
.
CallOption
ListVolumes
[]
gax
.
CallOption
GetVolume
[]
gax
.
CallOption
UpdateVolume
[]
gax
.
CallOption
ResizeVolume
[]
gax
.
CallOption
ListNetworks
[]
gax
.
CallOption
ListNetworkUsage
[]
gax
.
CallOption
GetNetwork
[]
gax
.
CallOption
UpdateNetwork
[]
gax
.
CallOption
GetLun
[]
gax
.
CallOption
ListLuns
[]
gax
.
CallOption
GetNfsShare
[]
gax
.
CallOption
ListNfsShares
[]
gax
.
CallOption
UpdateNfsShare
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
Client is a client for interacting with Bare Metal Solution API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Performs management operations on Bare Metal Solution servers.
The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.
func NewClient
NewClient creates a new bare metal solution client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Performs management operations on Bare Metal Solution servers.
The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new bare metal solution rest client.
Performs management operations on Bare Metal Solution servers.
The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) DetachLun
func
(
c
*
Client
)
DetachLun
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
DetachLunRequest
,
opts
...
gax
.
CallOption
)
(
*
DetachLunOperation
,
error
)
DetachLun detach LUN from Instance.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
DetachLunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#DetachLunRequest.
}
op
,
err
:=
c
.
DetachLun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DetachLunOperation
func
(
c
*
Client
)
DetachLunOperation
(
name
string
)
*
DetachLunOperation
DetachLunOperation returns a new DetachLunOperation from a given name. The name must be that of a previously created DetachLunOperation, possibly from a different process.
func (*Client) GetInstance
func
(
c
*
Client
)
GetInstance
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
GetInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Instance
,
error
)
GetInstance get details about a single server.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
GetInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#GetInstanceRequest.
}
resp
,
err
:=
c
.
GetInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetLocation
func
(
c
*
Client
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetLun
func
(
c
*
Client
)
GetLun
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
GetLunRequest
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Lun
,
error
)
GetLun get details of a single storage logical unit number(LUN).
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
GetLunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#GetLunRequest.
}
resp
,
err
:=
c
.
GetLun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetNetwork
func
(
c
*
Client
)
GetNetwork
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
GetNetworkRequest
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Network
,
error
)
GetNetwork get details of a single network.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
GetNetworkRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#GetNetworkRequest.
}
resp
,
err
:=
c
.
GetNetwork
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetNfsShare
func
(
c
*
Client
)
GetNfsShare
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
GetNfsShareRequest
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
NfsShare
,
error
)
GetNfsShare get details of a single NFS share.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
GetNfsShareRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#GetNfsShareRequest.
}
resp
,
err
:=
c
.
GetNfsShare
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetVolume
func
(
c
*
Client
)
GetVolume
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
GetVolumeRequest
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Volume
,
error
)
GetVolume get details of a single storage volume.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
GetVolumeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#GetVolumeRequest.
}
resp
,
err
:=
c
.
GetVolume
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListInstances
func
(
c
*
Client
)
ListInstances
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ListInstancesRequest
,
opts
...
gax
.
CallOption
)
*
InstanceIterator
ListInstances list servers in a given project and location.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ListInstancesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ListInstancesRequest.
}
it
:=
c
.
ListInstances
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListLocations
func
(
c
*
Client
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListLuns
func
(
c
*
Client
)
ListLuns
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ListLunsRequest
,
opts
...
gax
.
CallOption
)
*
LunIterator
ListLuns list storage volume luns for given storage volume.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ListLunsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ListLunsRequest.
}
it
:=
c
.
ListLuns
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListNetworkUsage
func
(
c
*
Client
)
ListNetworkUsage
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ListNetworkUsageRequest
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
ListNetworkUsageResponse
,
error
)
ListNetworkUsage list all Networks (and used IPs for each Network) in the vendor account associated with the specified project.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ListNetworkUsageRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ListNetworkUsageRequest.
}
resp
,
err
:=
c
.
ListNetworkUsage
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListNetworks
func
(
c
*
Client
)
ListNetworks
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ListNetworksRequest
,
opts
...
gax
.
CallOption
)
*
NetworkIterator
ListNetworks list network in a given project and location.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ListNetworksRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ListNetworksRequest.
}
it
:=
c
.
ListNetworks
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListNfsShares
func
(
c
*
Client
)
ListNfsShares
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ListNfsSharesRequest
,
opts
...
gax
.
CallOption
)
*
NfsShareIterator
ListNfsShares list NFS shares.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ListNfsSharesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ListNfsSharesRequest.
}
it
:=
c
.
ListNfsShares
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListVolumes
func
(
c
*
Client
)
ListVolumes
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ListVolumesRequest
,
opts
...
gax
.
CallOption
)
*
VolumeIterator
ListVolumes list storage volumes in a given project and location.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ListVolumesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ListVolumesRequest.
}
it
:=
c
.
ListVolumes
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ResetInstance
func
(
c
*
Client
)
ResetInstance
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ResetInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
ResetInstanceOperation
,
error
)
ResetInstance perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ResetInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ResetInstanceRequest.
}
op
,
err
:=
c
.
ResetInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ResetInstanceOperation
func
(
c
*
Client
)
ResetInstanceOperation
(
name
string
)
*
ResetInstanceOperation
ResetInstanceOperation returns a new ResetInstanceOperation from a given name. The name must be that of a previously created ResetInstanceOperation, possibly from a different process.
func (*Client) ResizeVolume
func
(
c
*
Client
)
ResizeVolume
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
ResizeVolumeRequest
,
opts
...
gax
.
CallOption
)
(
*
ResizeVolumeOperation
,
error
)
ResizeVolume emergency Volume resize.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
ResizeVolumeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#ResizeVolumeRequest.
}
op
,
err
:=
c
.
ResizeVolume
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ResizeVolumeOperation
func
(
c
*
Client
)
ResizeVolumeOperation
(
name
string
)
*
ResizeVolumeOperation
ResizeVolumeOperation returns a new ResizeVolumeOperation from a given name. The name must be that of a previously created ResizeVolumeOperation, possibly from a different process.
func (*Client) StartInstance
func
(
c
*
Client
)
StartInstance
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
StartInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
StartInstanceOperation
,
error
)
StartInstance starts a server that was shutdown.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
StartInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#StartInstanceRequest.
}
op
,
err
:=
c
.
StartInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) StartInstanceOperation
func
(
c
*
Client
)
StartInstanceOperation
(
name
string
)
*
StartInstanceOperation
StartInstanceOperation returns a new StartInstanceOperation from a given name. The name must be that of a previously created StartInstanceOperation, possibly from a different process.
func (*Client) StopInstance
func
(
c
*
Client
)
StopInstance
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
StopInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
StopInstanceOperation
,
error
)
StopInstance stop a running server.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
StopInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#StopInstanceRequest.
}
op
,
err
:=
c
.
StopInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) StopInstanceOperation
func
(
c
*
Client
)
StopInstanceOperation
(
name
string
)
*
StopInstanceOperation
StopInstanceOperation returns a new StopInstanceOperation from a given name. The name must be that of a previously created StopInstanceOperation, possibly from a different process.
func (*Client) UpdateInstance
func
(
c
*
Client
)
UpdateInstance
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
UpdateInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateInstanceOperation
,
error
)
UpdateInstance update details of a single server.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
UpdateInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#UpdateInstanceRequest.
}
op
,
err
:=
c
.
UpdateInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateInstanceOperation
func
(
c
*
Client
)
UpdateInstanceOperation
(
name
string
)
*
UpdateInstanceOperation
UpdateInstanceOperation returns a new UpdateInstanceOperation from a given name. The name must be that of a previously created UpdateInstanceOperation, possibly from a different process.
func (*Client) UpdateNetwork
func
(
c
*
Client
)
UpdateNetwork
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
UpdateNetworkRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateNetworkOperation
,
error
)
UpdateNetwork update details of a single network.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
UpdateNetworkRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#UpdateNetworkRequest.
}
op
,
err
:=
c
.
UpdateNetwork
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateNetworkOperation
func
(
c
*
Client
)
UpdateNetworkOperation
(
name
string
)
*
UpdateNetworkOperation
UpdateNetworkOperation returns a new UpdateNetworkOperation from a given name. The name must be that of a previously created UpdateNetworkOperation, possibly from a different process.
func (*Client) UpdateNfsShare
func
(
c
*
Client
)
UpdateNfsShare
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
UpdateNfsShareRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateNfsShareOperation
,
error
)
UpdateNfsShare update details of a single NFS share.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
UpdateNfsShareRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#UpdateNfsShareRequest.
}
op
,
err
:=
c
.
UpdateNfsShare
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateNfsShareOperation
func
(
c
*
Client
)
UpdateNfsShareOperation
(
name
string
)
*
UpdateNfsShareOperation
UpdateNfsShareOperation returns a new UpdateNfsShareOperation from a given name. The name must be that of a previously created UpdateNfsShareOperation, possibly from a different process.
func (*Client) UpdateVolume
func
(
c
*
Client
)
UpdateVolume
(
ctx
context
.
Context
,
req
*
baremetalsolutionpb
.
UpdateVolumeRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateVolumeOperation
,
error
)
UpdateVolume update details of a single storage volume.
Example
package
main
import
(
"context"
baremetalsolution
"cloud.google.com/go/baremetalsolution/apiv2"
baremetalsolutionpb
"cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
baremetalsolution
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& baremetalsolutionpb
.
UpdateVolumeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb#UpdateVolumeRequest.
}
op
,
err
:=
c
.
UpdateVolume
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateVolumeOperation
func
(
c
*
Client
)
UpdateVolumeOperation
(
name
string
)
*
UpdateVolumeOperation
UpdateVolumeOperation returns a new UpdateVolumeOperation from a given name. The name must be that of a previously created UpdateVolumeOperation, possibly from a different process.
DetachLunOperation
type
DetachLunOperation
struct
{
// contains filtered or unexported fields
}
DetachLunOperation manages a long-running operation from DetachLun.
func (*DetachLunOperation) Done
func
(
op
*
DetachLunOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DetachLunOperation) Metadata
func
(
op
*
DetachLunOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DetachLunOperation) Name
func
(
op
*
DetachLunOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DetachLunOperation) Poll
func
(
op
*
DetachLunOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DetachLunOperation) Wait
func
(
op
*
DetachLunOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Instance
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
InstanceIterator
type
InstanceIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
baremetalsolutionpb
.
Instance
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
InstanceIterator manages a stream of *baremetalsolutionpb.Instance.
func (*InstanceIterator) Next
func
(
it
*
InstanceIterator
)
Next
()
(
*
baremetalsolutionpb
.
Instance
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*InstanceIterator) PageInfo
func
(
it
*
InstanceIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
LocationIterator
type
LocationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
locationpb
.
Location
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) Next
func
(
it
*
LocationIterator
)
Next
()
(
*
locationpb
.
Location
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func
(
it
*
LocationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
LunIterator
type
LunIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
baremetalsolutionpb
.
Lun
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LunIterator manages a stream of *baremetalsolutionpb.Lun.
func (*LunIterator) Next
func
(
it
*
LunIterator
)
Next
()
(
*
baremetalsolutionpb
.
Lun
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LunIterator) PageInfo
func
(
it
*
LunIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
NetworkIterator
type
NetworkIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
baremetalsolutionpb
.
Network
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
NetworkIterator manages a stream of *baremetalsolutionpb.Network.
func (*NetworkIterator) Next
func
(
it
*
NetworkIterator
)
Next
()
(
*
baremetalsolutionpb
.
Network
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*NetworkIterator) PageInfo
func
(
it
*
NetworkIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
NfsShareIterator
type
NfsShareIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
baremetalsolutionpb
.
NfsShare
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
NfsShareIterator manages a stream of *baremetalsolutionpb.NfsShare.
func (*NfsShareIterator) Next
func
(
it
*
NfsShareIterator
)
Next
()
(
*
baremetalsolutionpb
.
NfsShare
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*NfsShareIterator) PageInfo
func
(
it
*
NfsShareIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ResetInstanceOperation
type
ResetInstanceOperation
struct
{
// contains filtered or unexported fields
}
ResetInstanceOperation manages a long-running operation from ResetInstance.
func (*ResetInstanceOperation) Done
func
(
op
*
ResetInstanceOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ResetInstanceOperation) Metadata
func
(
op
*
ResetInstanceOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ResetInstanceOperation) Name
func
(
op
*
ResetInstanceOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ResetInstanceOperation) Poll
func
(
op
*
ResetInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
ResetInstanceResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ResetInstanceOperation) Wait
func
(
op
*
ResetInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
ResetInstanceResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
ResizeVolumeOperation
type
ResizeVolumeOperation
struct
{
// contains filtered or unexported fields
}
ResizeVolumeOperation manages a long-running operation from ResizeVolume.
func (*ResizeVolumeOperation) Done
func
(
op
*
ResizeVolumeOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ResizeVolumeOperation) Metadata
func
(
op
*
ResizeVolumeOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ResizeVolumeOperation) Name
func
(
op
*
ResizeVolumeOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ResizeVolumeOperation) Poll
func
(
op
*
ResizeVolumeOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Volume
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ResizeVolumeOperation) Wait
func
(
op
*
ResizeVolumeOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Volume
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
StartInstanceOperation
type
StartInstanceOperation
struct
{
// contains filtered or unexported fields
}
StartInstanceOperation manages a long-running operation from StartInstance.
func (*StartInstanceOperation) Done
func
(
op
*
StartInstanceOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*StartInstanceOperation) Metadata
func
(
op
*
StartInstanceOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*StartInstanceOperation) Name
func
(
op
*
StartInstanceOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StartInstanceOperation) Poll
func
(
op
*
StartInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
StartInstanceResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*StartInstanceOperation) Wait
func
(
op
*
StartInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
StartInstanceResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
StopInstanceOperation
type
StopInstanceOperation
struct
{
// contains filtered or unexported fields
}
StopInstanceOperation manages a long-running operation from StopInstance.
func (*StopInstanceOperation) Done
func
(
op
*
StopInstanceOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*StopInstanceOperation) Metadata
func
(
op
*
StopInstanceOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*StopInstanceOperation) Name
func
(
op
*
StopInstanceOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StopInstanceOperation) Poll
func
(
op
*
StopInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
StopInstanceResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*StopInstanceOperation) Wait
func
(
op
*
StopInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
StopInstanceResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateInstanceOperation
type
UpdateInstanceOperation
struct
{
// contains filtered or unexported fields
}
UpdateInstanceOperation manages a long-running operation from UpdateInstance.
func (*UpdateInstanceOperation) Done
func
(
op
*
UpdateInstanceOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateInstanceOperation) Metadata
func
(
op
*
UpdateInstanceOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateInstanceOperation) Name
func
(
op
*
UpdateInstanceOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateInstanceOperation) Poll
func
(
op
*
UpdateInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateInstanceOperation) Wait
func
(
op
*
UpdateInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Instance
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateNetworkOperation
type
UpdateNetworkOperation
struct
{
// contains filtered or unexported fields
}
UpdateNetworkOperation manages a long-running operation from UpdateNetwork.
func (*UpdateNetworkOperation) Done
func
(
op
*
UpdateNetworkOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateNetworkOperation) Metadata
func
(
op
*
UpdateNetworkOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateNetworkOperation) Name
func
(
op
*
UpdateNetworkOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateNetworkOperation) Poll
func
(
op
*
UpdateNetworkOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Network
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateNetworkOperation) Wait
func
(
op
*
UpdateNetworkOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Network
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateNfsShareOperation
type
UpdateNfsShareOperation
struct
{
// contains filtered or unexported fields
}
UpdateNfsShareOperation manages a long-running operation from UpdateNfsShare.
func (*UpdateNfsShareOperation) Done
func
(
op
*
UpdateNfsShareOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateNfsShareOperation) Metadata
func
(
op
*
UpdateNfsShareOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateNfsShareOperation) Name
func
(
op
*
UpdateNfsShareOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateNfsShareOperation) Poll
func
(
op
*
UpdateNfsShareOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
NfsShare
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateNfsShareOperation) Wait
func
(
op
*
UpdateNfsShareOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
NfsShare
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateVolumeOperation
type
UpdateVolumeOperation
struct
{
// contains filtered or unexported fields
}
UpdateVolumeOperation manages a long-running operation from UpdateVolume.
func (*UpdateVolumeOperation) Done
func
(
op
*
UpdateVolumeOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateVolumeOperation) Metadata
func
(
op
*
UpdateVolumeOperation
)
Metadata
()
(
*
baremetalsolutionpb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateVolumeOperation) Name
func
(
op
*
UpdateVolumeOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateVolumeOperation) Poll
func
(
op
*
UpdateVolumeOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Volume
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateVolumeOperation) Wait
func
(
op
*
UpdateVolumeOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
baremetalsolutionpb
.
Volume
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
VolumeIterator
type
VolumeIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
baremetalsolutionpb
.
Volume
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
VolumeIterator manages a stream of *baremetalsolutionpb.Volume.
func (*VolumeIterator) Next
func
(
it
*
VolumeIterator
)
Next
()
(
*
baremetalsolutionpb
.
Volume
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*VolumeIterator) PageInfo
func
(
it
*
VolumeIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
