baremetalsolution

Documentation

Overview

Package baremetalsolution provides access to the Bare Metal Solution API.

For product documentation, see: https://cloud.google.com/bare-metal

Creating a client

Usage example:

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

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

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

baremetalsolutionService, err := baremetalsolution.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

• Constants
• type ProjectsLocationsInstancesResetInstanceCall
  • func (c *ProjectsLocationsInstancesResetInstanceCall) Context(ctx context.Context) *ProjectsLocationsInstancesResetInstanceCall
  • func (c *ProjectsLocationsInstancesResetInstanceCall) Do(opts ...googleapi.CallOption) (*ResetInstanceResponse, error)
  • func (c *ProjectsLocationsInstancesResetInstanceCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesResetInstanceCall
  • func (c *ProjectsLocationsInstancesResetInstanceCall) Header() http.Header
• type ProjectsLocationsInstancesService
  • func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService
  • func (r *ProjectsLocationsInstancesService) ResetInstance(instance string, resetinstancerequest *ResetInstanceRequest) *ProjectsLocationsInstancesResetInstanceCall
• type ProjectsLocationsService
  • func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
• type ProjectsService
  • func NewProjectsService(s *Service) *ProjectsService
• type ResetInstanceRequest
• type ResetInstanceResponse
• type Service
  • func New(client *http.Client) (*Service, error)
  • func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

Constants

const (
	// See, edit, configure, and delete your Google Cloud Platform data
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Types

type ProjectsLocationsInstancesResetInstanceCall

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

func (*ProjectsLocationsInstancesResetInstanceCall) Context

func (c *ProjectsLocationsInstancesResetInstanceCall) Context(ctx context.Context) *ProjectsLocationsInstancesResetInstanceCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsInstancesResetInstanceCall) Do

func (c *ProjectsLocationsInstancesResetInstanceCall) Do(opts ...googleapi.CallOption) (*ResetInstanceResponse, error)

Do executes the "baremetalsolution.projects.locations.instances.resetInstance" call. Exactly one of *ResetInstanceResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ResetInstanceResponse.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 (*ProjectsLocationsInstancesResetInstanceCall) Fields

func (c *ProjectsLocationsInstancesResetInstanceCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesResetInstanceCall

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

func (*ProjectsLocationsInstancesResetInstanceCall) Header

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

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

type ProjectsLocationsInstancesService

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

func NewProjectsLocationsInstancesService

func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService

func (*ProjectsLocationsInstancesService) ResetInstance

func (r *ProjectsLocationsInstancesService) ResetInstance(instance string, resetinstancerequest *ResetInstanceRequest) *ProjectsLocationsInstancesResetInstanceCall

ResetInstance: Perform an ungraceful, hard reset on a machine (equivalent to shutting the power off, and then turning it back on).

- instance: Name of the instance to reset.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Instances *ProjectsLocationsInstancesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService

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

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type ResetInstanceRequest

type ResetInstanceRequest struct {
}

ResetInstanceRequest: Request for ResetInstance.

type ResetInstanceResponse

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

ResetInstanceResponse: Response for ResetInstance.

type Service

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New

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

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

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

func NewService

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

NewService creates a new Service.