replicapool

package
v2.3.0-rc.2+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 28, 2016 License: BSD-3-Clause, Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package replicapool provides access to the Replica Pool API.

See https://developers.google.com/compute/docs/replica-pool/

Usage example: 

import "google.golang.org/api/replicapool/v1beta1"
...
replicapoolService, err := replicapool.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud Platform services
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"

	// View and manage your Google Cloud Platform management resources and
	// deployment status information
	NdevCloudmanScope = "https://www.googleapis.com/auth/ndev.cloudman"

	// View your Google Cloud Platform management resources and deployment
	// status information
	NdevCloudmanReadonlyScope = "https://www.googleapis.com/auth/ndev.cloudman.readonly"

	// View and manage replica pools
	ReplicapoolScope = "https://www.googleapis.com/auth/replicapool"

	// View replica pools
	ReplicapoolReadonlyScope = "https://www.googleapis.com/auth/replicapool.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessConfig 

type AccessConfig struct {
	// Name: Name of this access configuration.
	Name string `json:"name,omitempty"`

	// NatIp: An external IP address associated with this instance.
	NatIp string `json:"natIp,omitempty"`

	// Type: Type of this access configuration file. Currently only
	// ONE_TO_ONE_NAT is supported.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

AccessConfig: A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.

func (*AccessConfig) MarshalJSON 

func (s *AccessConfig) MarshalJSON() ([]byte, error)

type Action 

type Action struct {
	// Commands: A list of commands to run, one per line. If any command
	// fails, the whole action is considered a failure and no further
	// actions are run. This also marks the virtual machine or replica as a
	// failure.
	Commands []string `json:"commands,omitempty"`

	// EnvVariables: A list of environment variables to use for the commands
	// in this action.
	EnvVariables []*EnvVariable `json:"envVariables,omitempty"`

	// TimeoutMilliSeconds: If an action's commands on a particular replica
	// do not finish in the specified timeoutMilliSeconds, the replica is
	// considered to be in a FAILING state. No efforts are made to stop any
	// processes that were spawned or created as the result of running the
	// action's commands. The default is the max allowed value, 1 hour (i.e.
	// 3600000 milliseconds).
	TimeoutMilliSeconds int64 `json:"timeoutMilliSeconds,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Commands") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Action: An action that gets executed during initialization of the replicas.

func (*Action) MarshalJSON 

func (s *Action) MarshalJSON() ([]byte, error)

type DiskAttachment 

type DiskAttachment struct {
	// DeviceName: The device name of this disk.
	DeviceName string `json:"deviceName,omitempty"`

	// Index: A zero-based index to assign to this disk, where 0 is reserved
	// for the boot disk. If not specified, this is assigned by the server.
	Index int64 `json:"index,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeviceName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

DiskAttachment: Specifies how to attach a disk to a Replica.

func (*DiskAttachment) MarshalJSON 

func (s *DiskAttachment) MarshalJSON() ([]byte, error)

type EnvVariable 

type EnvVariable struct {
	// Hidden: Deprecated, do not use.
	Hidden bool `json:"hidden,omitempty"`

	// Name: The name of the environment variable.
	Name string `json:"name,omitempty"`

	// Value: The value of the variable.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Hidden") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

EnvVariable: An environment variable to set for an action.

func (*EnvVariable) MarshalJSON 

func (s *EnvVariable) MarshalJSON() ([]byte, error)

type ExistingDisk 

type ExistingDisk struct {
	// Attachment: How the disk will be attached to the Replica.
	Attachment *DiskAttachment `json:"attachment,omitempty"`

	// Source: The name of the Persistent Disk resource. The Persistent Disk
	// resource must be in the same zone as the Pool.
	Source string `json:"source,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Attachment") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ExistingDisk: A pre-existing persistent disk that will be attached to every Replica in the Pool in READ_ONLY mode.

func (*ExistingDisk) MarshalJSON 

func (s *ExistingDisk) MarshalJSON() ([]byte, error)

type HealthCheck 

type HealthCheck struct {
	// CheckIntervalSec: How often (in seconds) to make HTTP requests for
	// this healthcheck. The default value is 5 seconds.
	CheckIntervalSec int64 `json:"checkIntervalSec,omitempty"`

	// Description: The description for this health check.
	Description string `json:"description,omitempty"`

	// HealthyThreshold: The number of consecutive health check requests
	// that need to succeed before the replica is considered healthy again.
	// The default value is 2.
	HealthyThreshold int64 `json:"healthyThreshold,omitempty"`

	// Host: The value of the host header in the HTTP health check request.
	// If left empty (default value), the localhost IP 127.0.0.1 will be
	// used.
	Host string `json:"host,omitempty"`

	// Name: The name of this health check.
	Name string `json:"name,omitempty"`

	// Path: The localhost request path to send this health check, in the
	// format /path/to/use. For example, /healthcheck.
	Path string `json:"path,omitempty"`

	// Port: The TCP port for the health check requests.
	Port int64 `json:"port,omitempty"`

	// TimeoutSec: How long (in seconds) to wait before a timeout failure
	// for this healthcheck. The default value is 5 seconds.
	TimeoutSec int64 `json:"timeoutSec,omitempty"`

	// UnhealthyThreshold: The number of consecutive health check requests
	// that need to fail in order to consider the replica unhealthy. The
	// default value is 2.
	UnhealthyThreshold int64 `json:"unhealthyThreshold,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CheckIntervalSec") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*HealthCheck) MarshalJSON 

func (s *HealthCheck) MarshalJSON() ([]byte, error)

type Label 

type Label struct {
	// Key: The key for this label.
	Key string `json:"key,omitempty"`

	// Value: The value of this label.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Label: A label to apply to this replica pool.

func (*Label) MarshalJSON 

func (s *Label) MarshalJSON() ([]byte, error)

type Metadata 

type Metadata struct {
	// FingerPrint: The fingerprint of the metadata. Required for updating
	// the metadata entries for this instance.
	FingerPrint string `json:"fingerPrint,omitempty"`

	// Items: A list of metadata items.
	Items []*MetadataItem `json:"items,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FingerPrint") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Metadata: A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource.

func (*Metadata) MarshalJSON 

func (s *Metadata) MarshalJSON() ([]byte, error)

type MetadataItem 

type MetadataItem struct {
	// Key: A metadata key.
	Key string `json:"key,omitempty"`

	// Value: A metadata value.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

MetadataItem: A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.

func (*MetadataItem) MarshalJSON 

func (s *MetadataItem) MarshalJSON() ([]byte, error)

type NetworkInterface 

type NetworkInterface struct {
	// AccessConfigs: An array of configurations for this interface. This
	// specifies how this interface is configured to interact with other
	// network services.
	AccessConfigs []*AccessConfig `json:"accessConfigs,omitempty"`

	// Network: Name the Network resource to which this interface applies.
	Network string `json:"network,omitempty"`

	// NetworkIp: An optional IPV4 internal network address to assign to the
	// instance for this network interface.
	NetworkIp string `json:"networkIp,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AccessConfigs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

NetworkInterface: A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.

func (*NetworkInterface) MarshalJSON 

func (s *NetworkInterface) MarshalJSON() ([]byte, error)

type NewDisk 

type NewDisk struct {
	// Attachment: How the disk will be attached to the Replica.
	Attachment *DiskAttachment `json:"attachment,omitempty"`

	// AutoDelete: If true, then this disk will be deleted when the instance
	// is deleted. The default value is true.
	AutoDelete bool `json:"autoDelete,omitempty"`

	// Boot: If true, indicates that this is the root persistent disk.
	Boot bool `json:"boot,omitempty"`

	// InitializeParams: Create the new disk using these parameters. The
	// name of the disk will be <instance_name>-<four_random_charactersgt;.
	InitializeParams *NewDiskInitializeParams `json:"initializeParams,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Attachment") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

NewDisk: A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode.

func (*NewDisk) MarshalJSON 

func (s *NewDisk) MarshalJSON() ([]byte, error)

type NewDiskInitializeParams 

type NewDiskInitializeParams struct {
	// DiskSizeGb: The size of the created disk in gigabytes.
	DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`

	// DiskType: Name of the disk type resource describing which disk type
	// to use to create the disk. For example 'pd-ssd' or 'pd-standard'.
	// Default is 'pd-standard'
	DiskType string `json:"diskType,omitempty"`

	// SourceImage: The name or fully-qualified URL of a source image to use
	// to create this disk. If you provide a name of the source image,
	// Replica Pool will look for an image with that name in your project.
	// If you are specifying an image provided by Compute Engine, you will
	// need to provide the full URL with the correct project, such
	// as:
	// http://www.googleapis.com/compute/v1/projects/debian-cloud/
	// global/images/debian-wheezy-7-vYYYYMMDD
	SourceImage string `json:"sourceImage,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DiskSizeGb") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

NewDiskInitializeParams: Initialization parameters for creating a new disk.

func (*NewDiskInitializeParams) MarshalJSON 

func (s *NewDiskInitializeParams) MarshalJSON() ([]byte, error)

type Pool 

type Pool struct {
	// AutoRestart: Whether replicas in this pool should be restarted if
	// they experience a failure. The default value is true.
	AutoRestart bool `json:"autoRestart,omitempty"`

	// BaseInstanceName: The base instance name to use for the replicas in
	// this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If
	// specified, the instances in this replica pool will be named in the
	// format <base-instance-name>-<ID>. The <ID> postfix will be a four
	// character alphanumeric identifier generated by the service.
	//
	// If this is not specified by the user, a random base instance name is
	// generated by the service.
	BaseInstanceName string `json:"baseInstanceName,omitempty"`

	// CurrentNumReplicas: [Output Only] The current number of replicas in
	// the pool.
	CurrentNumReplicas int64 `json:"currentNumReplicas,omitempty"`

	// Description: An optional description of the replica pool.
	Description string `json:"description,omitempty"`

	// HealthChecks: Deprecated. Please use template[].healthChecks instead.
	HealthChecks []*HealthCheck `json:"healthChecks,omitempty"`

	// InitialNumReplicas: The initial number of replicas this pool should
	// have. You must provide a value greater than or equal to 0.
	InitialNumReplicas int64 `json:"initialNumReplicas,omitempty"`

	// Labels: A list of labels to attach to this replica pool and all
	// created virtual machines in this replica pool.
	Labels []*Label `json:"labels,omitempty"`

	// Name: The name of the replica pool. Must follow the regex
	// [a-z]([-a-z0-9]*[a-z0-9])? and be 1-28 characters long.
	Name string `json:"name,omitempty"`

	// NumReplicas: Deprecated! Use initial_num_replicas instead.
	NumReplicas int64 `json:"numReplicas,omitempty"`

	// ResourceViews: The list of resource views that should be updated with
	// all the replicas that are managed by this pool.
	ResourceViews []string `json:"resourceViews,omitempty"`

	// SelfLink: [Output Only] A self-link to the replica pool.
	SelfLink string `json:"selfLink,omitempty"`

	// TargetPool: Deprecated, please use target_pools instead.
	TargetPool string `json:"targetPool,omitempty"`

	// TargetPools: A list of target pools to update with the replicas that
	// are managed by this pool. If specified, the replicas in this replica
	// pool will be added to the specified target pools for load balancing
	// purposes. The replica pool must live in the same region as the
	// specified target pools. These values must be the target pool resource
	// names, and not fully qualified URLs.
	TargetPools []string `json:"targetPools,omitempty"`

	// Template: The template to use when creating replicas in this pool.
	// This template is used during initial instance creation of the pool,
	// when growing the pool in size, or when a replica restarts.
	Template *Template `json:"template,omitempty"`

	// Type: Deprecated! Do not set.
	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. "AutoRestart") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Pool) MarshalJSON 

func (s *Pool) MarshalJSON() ([]byte, error)

type PoolsDeleteCall 

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

func (*PoolsDeleteCall) Context 

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

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 (*PoolsDeleteCall) Do 

func (c *PoolsDeleteCall) Do() error

Do executes the "replicapool.pools.delete" call.

func (*PoolsDeleteCall) Fields 

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

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

type PoolsDeleteRequest 

type PoolsDeleteRequest struct {
	// AbandonInstances: If there are instances you would like to keep, you
	// can specify them here. These instances won't be deleted, but the
	// associated replica objects will be removed.
	AbandonInstances []string `json:"abandonInstances,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AbandonInstances") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*PoolsDeleteRequest) MarshalJSON 

func (s *PoolsDeleteRequest) MarshalJSON() ([]byte, error)

type PoolsGetCall 

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

func (*PoolsGetCall) Context 

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

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 (*PoolsGetCall) Do 

func (c *PoolsGetCall) Do() (*Pool, error)

Do executes the "replicapool.pools.get" call. Exactly one of *Pool or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Pool.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 (*PoolsGetCall) Fields 

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

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

func (*PoolsGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type PoolsInsertCall 

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

func (*PoolsInsertCall) Context 

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

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 (*PoolsInsertCall) Do 

func (c *PoolsInsertCall) Do() (*Pool, error)

Do executes the "replicapool.pools.insert" call. Exactly one of *Pool or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Pool.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 (*PoolsInsertCall) Fields 

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

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

type PoolsListCall 

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

func (*PoolsListCall) Context 

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

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 (*PoolsListCall) Do 

func (c *PoolsListCall) Do() (*PoolsListResponse, error)

Do executes the "replicapool.pools.list" call. Exactly one of *PoolsListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PoolsListResponse.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 (*PoolsListCall) Fields 

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

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

func (*PoolsListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*PoolsListCall) MaxResults 

func (c *PoolsListCall) MaxResults(maxResults int64) *PoolsListCall

MaxResults sets the optional parameter "maxResults": Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)

func (*PoolsListCall) PageToken 

func (c *PoolsListCall) PageToken(pageToken string) *PoolsListCall

PageToken sets the optional parameter "pageToken": Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request.

type PoolsListResponse 

type PoolsListResponse struct {
	NextPageToken string `json:"nextPageToken,omitempty"`

	Resources []*Pool `json:"resources,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*PoolsListResponse) MarshalJSON 

func (s *PoolsListResponse) MarshalJSON() ([]byte, error)

type PoolsResizeCall 

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

func (*PoolsResizeCall) Context 

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

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 (*PoolsResizeCall) Do 

func (c *PoolsResizeCall) Do() (*Pool, error)

Do executes the "replicapool.pools.resize" call. Exactly one of *Pool or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Pool.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 (*PoolsResizeCall) Fields 

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

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

func (*PoolsResizeCall) NumReplicas 

func (c *PoolsResizeCall) NumReplicas(numReplicas int64) *PoolsResizeCall

NumReplicas sets the optional parameter "numReplicas": The desired number of replicas to resize to. If this number is larger than the existing number of replicas, new replicas will be added. If the number is smaller, then existing replicas will be deleted.

type PoolsService 

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

func NewPoolsService 

func NewPoolsService(s *Service) *PoolsService

func (*PoolsService) Delete 

func (r *PoolsService) Delete(projectName string, zone string, poolName string, poolsdeleterequest *PoolsDeleteRequest) *PoolsDeleteCall

Delete: Deletes a replica pool.

func (*PoolsService) Get 

func (r *PoolsService) Get(projectName string, zone string, poolName string) *PoolsGetCall

Get: Gets information about a single replica pool.

func (*PoolsService) Insert 

func (r *PoolsService) Insert(projectName string, zone string, pool *Pool) *PoolsInsertCall

Insert: Inserts a new replica pool.

func (*PoolsService) List 

func (r *PoolsService) List(projectName string, zone string) *PoolsListCall

List: List all replica pools.

func (*PoolsService) Resize 

func (r *PoolsService) Resize(projectName string, zone string, poolName string) *PoolsResizeCall

Resize: Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last resize request.

func (*PoolsService) Updatetemplate 

func (r *PoolsService) Updatetemplate(projectName string, zone string, poolName string, template *Template) *PoolsUpdatetemplateCall

Updatetemplate: Update the template used by the pool.

type PoolsUpdatetemplateCall 

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

func (*PoolsUpdatetemplateCall) Context 

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

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 (*PoolsUpdatetemplateCall) Do 

func (c *PoolsUpdatetemplateCall) Do() error

Do executes the "replicapool.pools.updatetemplate" call.

func (*PoolsUpdatetemplateCall) Fields 

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

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

type Replica 

type Replica struct {
	// Name: [Output Only] The name of the Replica object.
	Name string `json:"name,omitempty"`

	// SelfLink: [Output Only] The self-link of the Replica.
	SelfLink string `json:"selfLink,omitempty"`

	// Status: [Output Only] Last known status of the Replica.
	Status *ReplicaStatus `json:"status,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Replica: An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas.

func (*Replica) MarshalJSON 

func (s *Replica) MarshalJSON() ([]byte, error)

type ReplicaStatus 

type ReplicaStatus struct {
	// Details: [Output Only] Human-readable details about the current state
	// of the replica
	Details string `json:"details,omitempty"`

	// State: [Output Only] The state of the Replica.
	State string `json:"state,omitempty"`

	// TemplateVersion: [Output Only] The template used to build the
	// replica.
	TemplateVersion string `json:"templateVersion,omitempty"`

	// VmLink: [Output Only] Link to the virtual machine that this Replica
	// represents.
	VmLink string `json:"vmLink,omitempty"`

	// VmStartTime: [Output Only] The time that this Replica got to the
	// RUNNING state, in RFC 3339 format. If the start time is unknown,
	// UNKNOWN is returned.
	VmStartTime string `json:"vmStartTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Details") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ReplicaStatus: The current status of a Replica.

func (*ReplicaStatus) MarshalJSON 

func (s *ReplicaStatus) MarshalJSON() ([]byte, error)

type ReplicasDeleteCall 

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

func (*ReplicasDeleteCall) Context 

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

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 (*ReplicasDeleteCall) Do 

func (c *ReplicasDeleteCall) Do() (*Replica, error)

Do executes the "replicapool.replicas.delete" call. Exactly one of *Replica or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Replica.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 (*ReplicasDeleteCall) Fields 

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

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

type ReplicasDeleteRequest 

type ReplicasDeleteRequest struct {
	// AbandonInstance: Whether the instance resource represented by this
	// replica should be deleted or abandoned. If abandoned, the replica
	// will be deleted but the virtual machine instance will remain. By
	// default, this is set to false and the instance will be deleted along
	// with the replica.
	AbandonInstance bool `json:"abandonInstance,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AbandonInstance") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ReplicasDeleteRequest) MarshalJSON 

func (s *ReplicasDeleteRequest) MarshalJSON() ([]byte, error)

type ReplicasGetCall 

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

func (*ReplicasGetCall) Context 

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

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 (*ReplicasGetCall) Do 

func (c *ReplicasGetCall) Do() (*Replica, error)

Do executes the "replicapool.replicas.get" call. Exactly one of *Replica or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Replica.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 (*ReplicasGetCall) Fields 

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

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

func (*ReplicasGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ReplicasListCall 

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

func (*ReplicasListCall) Context 

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

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 (*ReplicasListCall) Do 

func (c *ReplicasListCall) Do() (*ReplicasListResponse, error)

Do executes the "replicapool.replicas.list" call. Exactly one of *ReplicasListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReplicasListResponse.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 (*ReplicasListCall) Fields 

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

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

func (*ReplicasListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ReplicasListCall) MaxResults 

func (c *ReplicasListCall) MaxResults(maxResults int64) *ReplicasListCall

MaxResults sets the optional parameter "maxResults": Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)

func (*ReplicasListCall) PageToken 

func (c *ReplicasListCall) PageToken(pageToken string) *ReplicasListCall

PageToken sets the optional parameter "pageToken": Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request.

type ReplicasListResponse 

type ReplicasListResponse struct {
	NextPageToken string `json:"nextPageToken,omitempty"`

	Resources []*Replica `json:"resources,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ReplicasListResponse) MarshalJSON 

func (s *ReplicasListResponse) MarshalJSON() ([]byte, error)

type ReplicasRestartCall 

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

func (*ReplicasRestartCall) Context 

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

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 (*ReplicasRestartCall) Do 

func (c *ReplicasRestartCall) Do() (*Replica, error)

Do executes the "replicapool.replicas.restart" call. Exactly one of *Replica or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Replica.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 (*ReplicasRestartCall) Fields 

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

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

type ReplicasService 

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

func NewReplicasService 

func NewReplicasService(s *Service) *ReplicasService

func (*ReplicasService) Delete 

func (r *ReplicasService) Delete(projectName string, zone string, poolName string, replicaName string, replicasdeleterequest *ReplicasDeleteRequest) *ReplicasDeleteCall

Delete: Deletes a replica from the pool.

func (*ReplicasService) Get 

func (r *ReplicasService) Get(projectName string, zone string, poolName string, replicaName string) *ReplicasGetCall

Get: Gets information about a specific replica.

func (*ReplicasService) List 

func (r *ReplicasService) List(projectName string, zone string, poolName string) *ReplicasListCall

List: Lists all replicas in a pool.

func (*ReplicasService) Restart 

func (r *ReplicasService) Restart(projectName string, zone string, poolName string, replicaName string) *ReplicasRestartCall

Restart: Restarts a replica in a pool.

type Service 

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

	Pools *PoolsService

	Replicas *ReplicasService
	// contains filtered or unexported fields
}

func New 

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

type ServiceAccount 

type ServiceAccount struct {
	// Email: The service account email address, for example:
	// 123845678986@project.gserviceaccount.com
	Email string `json:"email,omitempty"`

	// Scopes: The list of OAuth2 scopes to obtain for the service account,
	// for example: https://www.googleapis.com/auth/devstorage.full_control
	Scopes []string `json:"scopes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ServiceAccount: A Compute Engine service account, identical to the Compute Engine resource.

func (*ServiceAccount) MarshalJSON 

func (s *ServiceAccount) MarshalJSON() ([]byte, error)

type Tag 

type Tag struct {
	// FingerPrint: The fingerprint of the tag. Required for updating the
	// list of tags.
	FingerPrint string `json:"fingerPrint,omitempty"`

	// Items: Items contained in this tag.
	Items []string `json:"items,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FingerPrint") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Tag: A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource.

func (*Tag) MarshalJSON 

func (s *Tag) MarshalJSON() ([]byte, error)

type Template 

type Template struct {
	// Action: An action to run during initialization of your replicas. An
	// action is run as shell commands which are executed one after the
	// other in the same bash shell, so any state established by one command
	// is inherited by later commands.
	Action *Action `json:"action,omitempty"`

	// HealthChecks: A list of HTTP Health Checks to configure for this
	// replica pool and all virtual machines in this replica pool.
	HealthChecks []*HealthCheck `json:"healthChecks,omitempty"`

	// Version: A free-form string describing the version of this template.
	// You can provide any versioning string you would like. For example,
	// version1 or template-v1.
	Version string `json:"version,omitempty"`

	// VmParams: The virtual machine parameters to use for creating
	// replicas. You can define settings such as the machine type and the
	// image of replicas in this pool. This is required if replica type is
	// SMART_VM.
	VmParams *VmParams `json:"vmParams,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Action") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Template: The template used for creating replicas in the pool.

func (*Template) MarshalJSON 

func (s *Template) MarshalJSON() ([]byte, error)

type VmParams 

type VmParams struct {
	// BaseInstanceName: Deprecated. Please use baseInstanceName instead.
	BaseInstanceName string `json:"baseInstanceName,omitempty"`

	// CanIpForward: Enables IP Forwarding, which allows this instance to
	// receive packets destined for a different IP address, and send packets
	// with a different source IP. See IP Forwarding for more information.
	CanIpForward bool `json:"canIpForward,omitempty"`

	// Description: An optional textual description of the instance.
	Description string `json:"description,omitempty"`

	// DisksToAttach: A list of existing Persistent Disk resources to attach
	// to each replica in the pool. Each disk will be attached in read-only
	// mode to every replica.
	DisksToAttach []*ExistingDisk `json:"disksToAttach,omitempty"`

	// DisksToCreate: A list of Disk resources to create and attach to each
	// Replica in the Pool. Currently, you can only define one disk and it
	// must be a root persistent disk. Note that Replica Pool will create a
	// root persistent disk for each replica.
	DisksToCreate []*NewDisk `json:"disksToCreate,omitempty"`

	// MachineType: The machine type for this instance. The resource name
	// (e.g. n1-standard-1).
	MachineType string `json:"machineType,omitempty"`

	// Metadata: The metadata key/value pairs assigned to this instance.
	Metadata *Metadata `json:"metadata,omitempty"`

	// NetworkInterfaces: A list of network interfaces for the instance.
	// Currently only one interface is supported by Google Compute Engine,
	// ONE_TO_ONE_NAT.
	NetworkInterfaces []*NetworkInterface `json:"networkInterfaces,omitempty"`

	OnHostMaintenance string `json:"onHostMaintenance,omitempty"`

	// ServiceAccounts: A list of Service Accounts to enable for this
	// instance.
	ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`

	// Tags: A list of tags to apply to the Google Compute Engine instance
	// to identify resources.
	Tags *Tag `json:"tags,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BaseInstanceName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

VmParams: Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource.

func (*VmParams) MarshalJSON 

func (s *VmParams) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.