replicapool
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package replicapool provides access to the Replica Pool API.
For product documentation, see:https://developers.google.com/compute/docs/replica-pool/
Creating a client¶
Usage example:
import "google.golang.org/api/replicapool/v1beta1"...ctx := context.Background()replicapoolService, err := replicapool.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
replicapoolService, err := replicapool.NewService(ctx, option.WithScopes(replicapool.ReplicapoolReadonlyScope))
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
replicapoolService, err := replicapool.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, ...)replicapoolService, err := replicapool.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seehttps://godoc.org/google.golang.org/api/option/ for details on options.
Index¶
- Constants
- type AccessConfig
- type Action
- type DiskAttachment
- type EnvVariable
- type ExistingDisk
- type HealthCheck
- type Label
- type Metadata
- type MetadataItem
- type NetworkInterface
- type NewDisk
- type NewDiskInitializeParams
- type Pool
- type PoolsDeleteCall
- type PoolsDeleteRequest
- type PoolsGetCall
- func (c *PoolsGetCall) Context(ctx context.Context) *PoolsGetCall
- func (c *PoolsGetCall) Do(opts ...googleapi.CallOption) (*Pool, error)
- func (c *PoolsGetCall) Fields(s ...googleapi.Field) *PoolsGetCall
- func (c *PoolsGetCall) Header() http.Header
- func (c *PoolsGetCall) IfNoneMatch(entityTag string) *PoolsGetCall
- type PoolsInsertCall
- type PoolsListCall
- func (c *PoolsListCall) Context(ctx context.Context) *PoolsListCall
- func (c *PoolsListCall) Do(opts ...googleapi.CallOption) (*PoolsListResponse, error)
- func (c *PoolsListCall) Fields(s ...googleapi.Field) *PoolsListCall
- func (c *PoolsListCall) Header() http.Header
- func (c *PoolsListCall) IfNoneMatch(entityTag string) *PoolsListCall
- func (c *PoolsListCall) MaxResults(maxResults int64) *PoolsListCall
- func (c *PoolsListCall) PageToken(pageToken string) *PoolsListCall
- func (c *PoolsListCall) Pages(ctx context.Context, f func(*PoolsListResponse) error) error
- type PoolsListResponse
- type PoolsResizeCall
- func (c *PoolsResizeCall) Context(ctx context.Context) *PoolsResizeCall
- func (c *PoolsResizeCall) Do(opts ...googleapi.CallOption) (*Pool, error)
- func (c *PoolsResizeCall) Fields(s ...googleapi.Field) *PoolsResizeCall
- func (c *PoolsResizeCall) Header() http.Header
- func (c *PoolsResizeCall) NumReplicas(numReplicas int64) *PoolsResizeCall
- type PoolsService
- func (r *PoolsService) Delete(projectName string, zone string, poolName string, ...) *PoolsDeleteCall
- func (r *PoolsService) Get(projectName string, zone string, poolName string) *PoolsGetCall
- func (r *PoolsService) Insert(projectName string, zone string, pool *Pool) *PoolsInsertCall
- func (r *PoolsService) List(projectName string, zone string) *PoolsListCall
- func (r *PoolsService) Resize(projectName string, zone string, poolName string) *PoolsResizeCall
- func (r *PoolsService) Updatetemplate(projectName string, zone string, poolName string, template *Template) *PoolsUpdatetemplateCall
- type PoolsUpdatetemplateCall
- func (c *PoolsUpdatetemplateCall) Context(ctx context.Context) *PoolsUpdatetemplateCall
- func (c *PoolsUpdatetemplateCall) Do(opts ...googleapi.CallOption) error
- func (c *PoolsUpdatetemplateCall) Fields(s ...googleapi.Field) *PoolsUpdatetemplateCall
- func (c *PoolsUpdatetemplateCall) Header() http.Header
- type Replica
- type ReplicaStatus
- type ReplicasDeleteCall
- type ReplicasDeleteRequest
- type ReplicasGetCall
- func (c *ReplicasGetCall) Context(ctx context.Context) *ReplicasGetCall
- func (c *ReplicasGetCall) Do(opts ...googleapi.CallOption) (*Replica, error)
- func (c *ReplicasGetCall) Fields(s ...googleapi.Field) *ReplicasGetCall
- func (c *ReplicasGetCall) Header() http.Header
- func (c *ReplicasGetCall) IfNoneMatch(entityTag string) *ReplicasGetCall
- type ReplicasListCall
- func (c *ReplicasListCall) Context(ctx context.Context) *ReplicasListCall
- func (c *ReplicasListCall) Do(opts ...googleapi.CallOption) (*ReplicasListResponse, error)
- func (c *ReplicasListCall) Fields(s ...googleapi.Field) *ReplicasListCall
- func (c *ReplicasListCall) Header() http.Header
- func (c *ReplicasListCall) IfNoneMatch(entityTag string) *ReplicasListCall
- func (c *ReplicasListCall) MaxResults(maxResults int64) *ReplicasListCall
- func (c *ReplicasListCall) PageToken(pageToken string) *ReplicasListCall
- func (c *ReplicasListCall) Pages(ctx context.Context, f func(*ReplicasListResponse) error) error
- type ReplicasListResponse
- type ReplicasRestartCall
- type ReplicasService
- func (r *ReplicasService) Delete(projectName string, zone string, poolName string, replicaName string, ...) *ReplicasDeleteCall
- func (r *ReplicasService) Get(projectName string, zone string, poolName string, replicaName string) *ReplicasGetCall
- func (r *ReplicasService) List(projectName string, zone string, poolName string) *ReplicasListCall
- func (r *ReplicasService) Restart(projectName string, zone string, poolName string, replicaName string) *ReplicasRestartCall
- type Service
- type ServiceAccount
- type Tag
- type Template
- type VmParams
Constants¶
const (// View and manage your data across Google Cloud Platform servicesCloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View your data across Google Cloud Platform servicesCloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"// View and manage your Google Cloud Platform management resources and// deployment status informationNdevCloudmanScope = "https://www.googleapis.com/auth/ndev.cloudman"// View your Google Cloud Platform management resources and deployment// status informationNdevCloudmanReadonlyScope = "https://www.googleapis.com/auth/ndev.cloudman.readonly"// View and manage replica poolsReplicapoolScope = "https://www.googleapis.com/auth/replicapool"// View replica poolsReplicapoolReadonlyScope = "https://www.googleapis.com/auth/replicapool.readonly")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAccessConfig¶
type AccessConfig struct {// Name: Name of this access configuration.Namestring `json:"name,omitempty"`// NatIp: An external IP address associated with this instance.NatIpstring `json:"natIp,omitempty"`// Type: Type of this access configuration file. Currently only// ONE_TO_ONE_NAT is supported.Typestring `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:"-"`// NullFields is a list of field names (e.g. "Name") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}AccessConfig: A Compute Engine network accessConfig. Identical to theaccessConfig on corresponding Compute Engine resource.
func (*AccessConfig)MarshalJSON¶
func (s *AccessConfig) MarshalJSON() ([]byte,error)
typeAction¶
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).TimeoutMilliSecondsint64 `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:"-"`// NullFields is a list of field names (e.g. "Commands") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}Action: An action that gets executed during initialization of thereplicas.
func (*Action)MarshalJSON¶
typeDiskAttachment¶
type DiskAttachment struct {// DeviceName: The device name of this disk.DeviceNamestring `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.Indexint64 `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:"-"`// NullFields is a list of field names (e.g. "DeviceName") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}DiskAttachment: Specifies how to attach a disk to a Replica.
func (*DiskAttachment)MarshalJSON¶
func (s *DiskAttachment) MarshalJSON() ([]byte,error)
typeEnvVariable¶
type EnvVariable struct {// Hidden: Deprecated, do not use.Hiddenbool `json:"hidden,omitempty"`// Name: The name of the environment variable.Namestring `json:"name,omitempty"`// Value: The value of the variable.Valuestring `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:"-"`// NullFields is a list of field names (e.g. "Hidden") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}EnvVariable: An environment variable to set for an action.
func (*EnvVariable)MarshalJSON¶
func (s *EnvVariable) MarshalJSON() ([]byte,error)
typeExistingDisk¶
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.Sourcestring `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:"-"`// NullFields is a list of field names (e.g. "Attachment") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}ExistingDisk: A pre-existing persistent disk that will be attached toevery Replica in the Pool in READ_ONLY mode.
func (*ExistingDisk)MarshalJSON¶
func (s *ExistingDisk) MarshalJSON() ([]byte,error)
typeHealthCheck¶
type HealthCheck struct {// CheckIntervalSec: How often (in seconds) to make HTTP requests for// this healthcheck. The default value is 5 seconds.CheckIntervalSecint64 `json:"checkIntervalSec,omitempty"`// Description: The description for this health check.Descriptionstring `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.HealthyThresholdint64 `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.Hoststring `json:"host,omitempty"`// Name: The name of this health check.Namestring `json:"name,omitempty"`// Path: The localhost request path to send this health check, in the// format /path/to/use. For example, /healthcheck.Pathstring `json:"path,omitempty"`// Port: The TCP port for the health check requests.Portint64 `json:"port,omitempty"`// TimeoutSec: How long (in seconds) to wait before a timeout failure// for this healthcheck. The default value is 5 seconds.TimeoutSecint64 `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.UnhealthyThresholdint64 `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:"-"`// NullFields is a list of field names (e.g. "CheckIntervalSec") to// include in API requests with the JSON null value. By default, fields// with empty values are omitted from API requests. However, any field// with an empty value appearing in NullFields will be sent to the// server as null. It is an error if a field in this list has a// non-empty value. This may be used to include null fields in Patch// requests.NullFields []string `json:"-"`}func (*HealthCheck)MarshalJSON¶
func (s *HealthCheck) MarshalJSON() ([]byte,error)
typeLabel¶
type Label struct {// Key: The key for this label.Keystring `json:"key,omitempty"`// Value: The value of this label.Valuestring `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:"-"`// NullFields is a list of field names (e.g. "Key") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}Label: A label to apply to this replica pool.
func (*Label)MarshalJSON¶
typeMetadata¶
type Metadata struct {// FingerPrint: The fingerprint of the metadata. Required for updating// the metadata entries for this instance.FingerPrintstring `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:"-"`// NullFields is a list of field names (e.g. "FingerPrint") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}Metadata: A Compute Engine metadata entry. Identical to the metadataon the corresponding Compute Engine resource.
func (*Metadata)MarshalJSON¶
typeMetadataItem¶
type MetadataItem struct {// Key: A metadata key.Keystring `json:"key,omitempty"`// Value: A metadata value.Valuestring `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:"-"`// NullFields is a list of field names (e.g. "Key") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}MetadataItem: A Compute Engine metadata item, defined as a key:valuepair. Identical to the metadata on the corresponding Compute Engineresource.
func (*MetadataItem)MarshalJSON¶
func (s *MetadataItem) MarshalJSON() ([]byte,error)
typeNetworkInterface¶
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.Networkstring `json:"network,omitempty"`// NetworkIp: An optional IPV4 internal network address to assign to the// instance for this network interface.NetworkIpstring `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:"-"`// NullFields is a list of field names (e.g. "AccessConfigs") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}NetworkInterface: A Compute Engine NetworkInterface resource.Identical to the NetworkInterface on the corresponding Compute Engineresource.
func (*NetworkInterface)MarshalJSON¶
func (s *NetworkInterface) MarshalJSON() ([]byte,error)
typeNewDisk¶
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.AutoDeletebool `json:"autoDelete,omitempty"`// Boot: If true, indicates that this is the root persistent disk.Bootbool `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:"-"`// NullFields is a list of field names (e.g. "Attachment") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}NewDisk: A Persistent Disk resource that will be created and attachedto each Replica in the Pool. Each Replica will have a uniquepersistent disk that is created and attached to that Replica inREAD_WRITE mode.
func (*NewDisk)MarshalJSON¶
typeNewDiskInitializeParams¶
type NewDiskInitializeParams struct {// DiskSizeGb: The size of the created disk in gigabytes.DiskSizeGbint64 `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'DiskTypestring `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-vYYYYMMDDSourceImagestring `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:"-"`// NullFields is a list of field names (e.g. "DiskSizeGb") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}NewDiskInitializeParams: Initialization parameters for creating a newdisk.
func (*NewDiskInitializeParams)MarshalJSON¶
func (s *NewDiskInitializeParams) MarshalJSON() ([]byte,error)
typePool¶
type Pool struct {// AutoRestart: Whether replicas in this pool should be restarted if// they experience a failure. The default value is true.AutoRestartbool `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.BaseInstanceNamestring `json:"baseInstanceName,omitempty"`// CurrentNumReplicas: [Output Only] The current number of replicas in// the pool.CurrentNumReplicasint64 `json:"currentNumReplicas,omitempty"`// Description: An optional description of the replica pool.Descriptionstring `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.InitialNumReplicasint64 `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.Namestring `json:"name,omitempty"`// NumReplicas: Deprecated! Use initial_num_replicas instead.NumReplicasint64 `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.SelfLinkstring `json:"selfLink,omitempty"`// TargetPool: Deprecated, please use target_pools instead.TargetPoolstring `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.Typestring `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:"-"`// NullFields is a list of field names (e.g. "AutoRestart") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}func (*Pool)MarshalJSON¶
typePoolsDeleteCall¶
type PoolsDeleteCall struct {// contains filtered or unexported fields}func (*PoolsDeleteCall)Context¶
func (c *PoolsDeleteCall) Context(ctxcontext.Context) *PoolsDeleteCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*PoolsDeleteCall)Do¶
func (c *PoolsDeleteCall) Do(opts ...googleapi.CallOption)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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*PoolsDeleteCall)Header¶
func (c *PoolsDeleteCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typePoolsDeleteRequest¶
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:"-"`// NullFields is a list of field names (e.g. "AbandonInstances") to// include in API requests with the JSON null value. By default, fields// with empty values are omitted from API requests. However, any field// with an empty value appearing in NullFields will be sent to the// server as null. It is an error if a field in this list has a// non-empty value. This may be used to include null fields in Patch// requests.NullFields []string `json:"-"`}func (*PoolsDeleteRequest)MarshalJSON¶
func (s *PoolsDeleteRequest) MarshalJSON() ([]byte,error)
typePoolsGetCall¶
type PoolsGetCall struct {// contains filtered or unexported fields}func (*PoolsGetCall)Context¶
func (c *PoolsGetCall) Context(ctxcontext.Context) *PoolsGetCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*PoolsGetCall)Do¶
func (c *PoolsGetCall) Do(opts ...googleapi.CallOption) (*Pool,error)
Do executes the "replicapool.pools.get" call.Exactly one of *Pool or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Pool.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified wasreturned.
func (*PoolsGetCall)Fields¶
func (c *PoolsGetCall) Fields(s ...googleapi.Field) *PoolsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*PoolsGetCall)Header¶
func (c *PoolsGetCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*PoolsGetCall)IfNoneMatch¶
func (c *PoolsGetCall) IfNoneMatch(entityTagstring) *PoolsGetCall
IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.
typePoolsInsertCall¶
type PoolsInsertCall struct {// contains filtered or unexported fields}func (*PoolsInsertCall)Context¶
func (c *PoolsInsertCall) Context(ctxcontext.Context) *PoolsInsertCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*PoolsInsertCall)Do¶
func (c *PoolsInsertCall) Do(opts ...googleapi.CallOption) (*Pool,error)
Do executes the "replicapool.pools.insert" call.Exactly one of *Pool or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Pool.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified wasreturned.
func (*PoolsInsertCall)Fields¶
func (c *PoolsInsertCall) Fields(s ...googleapi.Field) *PoolsInsertCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*PoolsInsertCall)Header¶
func (c *PoolsInsertCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typePoolsListCall¶
type PoolsListCall struct {// contains filtered or unexported fields}func (*PoolsListCall)Context¶
func (c *PoolsListCall) Context(ctxcontext.Context) *PoolsListCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*PoolsListCall)Do¶
func (c *PoolsListCall) Do(opts ...googleapi.CallOption) (*PoolsListResponse,error)
Do executes the "replicapool.pools.list" call.Exactly one of *PoolsListResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*PoolsListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.
func (*PoolsListCall)Fields¶
func (c *PoolsListCall) Fields(s ...googleapi.Field) *PoolsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*PoolsListCall)Header¶
func (c *PoolsListCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*PoolsListCall)IfNoneMatch¶
func (c *PoolsListCall) IfNoneMatch(entityTagstring) *PoolsListCall
IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.
func (*PoolsListCall)MaxResults¶
func (c *PoolsListCall) MaxResults(maxResultsint64) *PoolsListCall
MaxResults sets the optional parameter "maxResults": Maximum count ofresults to be returned. Acceptable values are 0 to 100, inclusive.(Default: 50)
func (*PoolsListCall)PageToken¶
func (c *PoolsListCall) PageToken(pageTokenstring) *PoolsListCall
PageToken sets the optional parameter "pageToken": Set this to thenextPageToken value returned by a previous list request to obtain thenext page of results from the previous list request.
func (*PoolsListCall)Pages¶
func (c *PoolsListCall) Pages(ctxcontext.Context, f func(*PoolsListResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typePoolsListResponse¶
type PoolsListResponse struct {NextPageTokenstring `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:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}func (*PoolsListResponse)MarshalJSON¶
func (s *PoolsListResponse) MarshalJSON() ([]byte,error)
typePoolsResizeCall¶
type PoolsResizeCall struct {// contains filtered or unexported fields}func (*PoolsResizeCall)Context¶
func (c *PoolsResizeCall) Context(ctxcontext.Context) *PoolsResizeCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*PoolsResizeCall)Do¶
func (c *PoolsResizeCall) Do(opts ...googleapi.CallOption) (*Pool,error)
Do executes the "replicapool.pools.resize" call.Exactly one of *Pool or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Pool.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified wasreturned.
func (*PoolsResizeCall)Fields¶
func (c *PoolsResizeCall) Fields(s ...googleapi.Field) *PoolsResizeCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*PoolsResizeCall)Header¶
func (c *PoolsResizeCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*PoolsResizeCall)NumReplicas¶
func (c *PoolsResizeCall) NumReplicas(numReplicasint64) *PoolsResizeCall
NumReplicas sets the optional parameter "numReplicas": The desirednumber of replicas to resize to. If this number is larger than theexisting number of replicas, new replicas will be added. If thenumber is smaller, then existing replicas will be deleted.
typePoolsService¶
type PoolsService struct {// contains filtered or unexported fields}funcNewPoolsService¶
func NewPoolsService(s *Service) *PoolsService
func (*PoolsService)Delete¶
func (r *PoolsService) Delete(projectNamestring, zonestring, poolNamestring, poolsdeleterequest *PoolsDeleteRequest) *PoolsDeleteCall
Delete: Deletes a replica pool.
func (*PoolsService)Get¶
func (r *PoolsService) Get(projectNamestring, zonestring, poolNamestring) *PoolsGetCall
Get: Gets information about a single replica pool.
func (*PoolsService)Insert¶
func (r *PoolsService) Insert(projectNamestring, zonestring, pool *Pool) *PoolsInsertCall
Insert: Inserts a new replica pool.
func (*PoolsService)List¶
func (r *PoolsService) List(projectNamestring, zonestring) *PoolsListCall
List: List all replica pools.
func (*PoolsService)Resize¶
func (r *PoolsService) Resize(projectNamestring, zonestring, poolNamestring) *PoolsResizeCall
Resize: Resize a pool. This is an asynchronous operation, andmultiple overlapping resize requests can be made. Replica Pools willuse the information from the last resize request.
func (*PoolsService)Updatetemplate¶
func (r *PoolsService) Updatetemplate(projectNamestring, zonestring, poolNamestring, template *Template) *PoolsUpdatetemplateCall
Updatetemplate: Update the template used by the pool.
typePoolsUpdatetemplateCall¶
type PoolsUpdatetemplateCall struct {// contains filtered or unexported fields}func (*PoolsUpdatetemplateCall)Context¶
func (c *PoolsUpdatetemplateCall) Context(ctxcontext.Context) *PoolsUpdatetemplateCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*PoolsUpdatetemplateCall)Do¶
func (c *PoolsUpdatetemplateCall) Do(opts ...googleapi.CallOption)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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*PoolsUpdatetemplateCall)Header¶
func (c *PoolsUpdatetemplateCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typeReplica¶
type Replica struct {// Name: [Output Only] The name of the Replica object.Namestring `json:"name,omitempty"`// SelfLink: [Output Only] The self-link of the Replica.SelfLinkstring `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:"-"`// NullFields is a list of field names (e.g. "Name") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}Replica: An individual Replica within a Pool. Replicas areautomatically created by the replica pool, using the templateprovided by the user. You cannot directly create replicas.
func (*Replica)MarshalJSON¶
typeReplicaStatus¶
type ReplicaStatus struct {// Details: [Output Only] Human-readable details about the current state// of the replicaDetailsstring `json:"details,omitempty"`// State: [Output Only] The state of the Replica.Statestring `json:"state,omitempty"`// TemplateVersion: [Output Only] The template used to build the// replica.TemplateVersionstring `json:"templateVersion,omitempty"`// VmLink: [Output Only] Link to the virtual machine that this Replica// represents.VmLinkstring `json:"vmLink,omitempty"`// VmStartTime: [Output Only] The time that this Replica got to the// RUNNING state, inRFC 3339 format. If the start time is unknown,// UNKNOWN is returned.VmStartTimestring `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:"-"`// NullFields is a list of field names (e.g. "Details") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}ReplicaStatus: The current status of a Replica.
func (*ReplicaStatus)MarshalJSON¶
func (s *ReplicaStatus) MarshalJSON() ([]byte,error)
typeReplicasDeleteCall¶
type ReplicasDeleteCall struct {// contains filtered or unexported fields}func (*ReplicasDeleteCall)Context¶
func (c *ReplicasDeleteCall) Context(ctxcontext.Context) *ReplicasDeleteCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ReplicasDeleteCall)Do¶
func (c *ReplicasDeleteCall) Do(opts ...googleapi.CallOption) (*Replica,error)
Do executes the "replicapool.replicas.delete" call.Exactly one of *Replica or error will be non-nil. Any non-2xx statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.
func (*ReplicasDeleteCall)Fields¶
func (c *ReplicasDeleteCall) Fields(s ...googleapi.Field) *ReplicasDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ReplicasDeleteCall)Header¶
func (c *ReplicasDeleteCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typeReplicasDeleteRequest¶
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.AbandonInstancebool `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:"-"`// NullFields is a list of field names (e.g. "AbandonInstance") to// include in API requests with the JSON null value. By default, fields// with empty values are omitted from API requests. However, any field// with an empty value appearing in NullFields will be sent to the// server as null. It is an error if a field in this list has a// non-empty value. This may be used to include null fields in Patch// requests.NullFields []string `json:"-"`}func (*ReplicasDeleteRequest)MarshalJSON¶
func (s *ReplicasDeleteRequest) MarshalJSON() ([]byte,error)
typeReplicasGetCall¶
type ReplicasGetCall struct {// contains filtered or unexported fields}func (*ReplicasGetCall)Context¶
func (c *ReplicasGetCall) Context(ctxcontext.Context) *ReplicasGetCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ReplicasGetCall)Do¶
func (c *ReplicasGetCall) Do(opts ...googleapi.CallOption) (*Replica,error)
Do executes the "replicapool.replicas.get" call.Exactly one of *Replica or error will be non-nil. Any non-2xx statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.
func (*ReplicasGetCall)Fields¶
func (c *ReplicasGetCall) Fields(s ...googleapi.Field) *ReplicasGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ReplicasGetCall)Header¶
func (c *ReplicasGetCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*ReplicasGetCall)IfNoneMatch¶
func (c *ReplicasGetCall) IfNoneMatch(entityTagstring) *ReplicasGetCall
IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.
typeReplicasListCall¶
type ReplicasListCall struct {// contains filtered or unexported fields}func (*ReplicasListCall)Context¶
func (c *ReplicasListCall) Context(ctxcontext.Context) *ReplicasListCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ReplicasListCall)Do¶
func (c *ReplicasListCall) Do(opts ...googleapi.CallOption) (*ReplicasListResponse,error)
Do executes the "replicapool.replicas.list" call.Exactly one of *ReplicasListResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*ReplicasListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.
func (*ReplicasListCall)Fields¶
func (c *ReplicasListCall) Fields(s ...googleapi.Field) *ReplicasListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ReplicasListCall)Header¶
func (c *ReplicasListCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*ReplicasListCall)IfNoneMatch¶
func (c *ReplicasListCall) IfNoneMatch(entityTagstring) *ReplicasListCall
IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.
func (*ReplicasListCall)MaxResults¶
func (c *ReplicasListCall) MaxResults(maxResultsint64) *ReplicasListCall
MaxResults sets the optional parameter "maxResults": Maximum count ofresults to be returned. Acceptable values are 0 to 100, inclusive.(Default: 50)
func (*ReplicasListCall)PageToken¶
func (c *ReplicasListCall) PageToken(pageTokenstring) *ReplicasListCall
PageToken sets the optional parameter "pageToken": Set this to thenextPageToken value returned by a previous list request to obtain thenext page of results from the previous list request.
func (*ReplicasListCall)Pages¶
func (c *ReplicasListCall) Pages(ctxcontext.Context, f func(*ReplicasListResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeReplicasListResponse¶
type ReplicasListResponse struct {NextPageTokenstring `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:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}func (*ReplicasListResponse)MarshalJSON¶
func (s *ReplicasListResponse) MarshalJSON() ([]byte,error)
typeReplicasRestartCall¶
type ReplicasRestartCall struct {// contains filtered or unexported fields}func (*ReplicasRestartCall)Context¶
func (c *ReplicasRestartCall) Context(ctxcontext.Context) *ReplicasRestartCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ReplicasRestartCall)Do¶
func (c *ReplicasRestartCall) Do(opts ...googleapi.CallOption) (*Replica,error)
Do executes the "replicapool.replicas.restart" call.Exactly one of *Replica or error will be non-nil. Any non-2xx statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.
func (*ReplicasRestartCall)Fields¶
func (c *ReplicasRestartCall) Fields(s ...googleapi.Field) *ReplicasRestartCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ReplicasRestartCall)Header¶
func (c *ReplicasRestartCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typeReplicasService¶
type ReplicasService struct {// contains filtered or unexported fields}funcNewReplicasService¶
func NewReplicasService(s *Service) *ReplicasService
func (*ReplicasService)Delete¶
func (r *ReplicasService) Delete(projectNamestring, zonestring, poolNamestring, replicaNamestring, replicasdeleterequest *ReplicasDeleteRequest) *ReplicasDeleteCall
Delete: Deletes a replica from the pool.
func (*ReplicasService)Get¶
func (r *ReplicasService) Get(projectNamestring, zonestring, poolNamestring, replicaNamestring) *ReplicasGetCall
Get: Gets information about a specific replica.
func (*ReplicasService)List¶
func (r *ReplicasService) List(projectNamestring, zonestring, poolNamestring) *ReplicasListCall
List: Lists all replicas in a pool.
func (*ReplicasService)Restart¶
func (r *ReplicasService) Restart(projectNamestring, zonestring, poolNamestring, replicaNamestring) *ReplicasRestartCall
Restart: Restarts a replica in a pool.
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentPools *PoolsServiceReplicas *ReplicasService// contains filtered or unexported fields} funcNewdeprecated
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.
funcNewService¶added inv0.3.0
NewService creates a new Service.
typeServiceAccount¶
type ServiceAccount struct {// Email: The service account email address, for example:// 123845678986@project.gserviceaccount.comEmailstring `json:"email,omitempty"`// Scopes: The list of OAuth2 scopes to obtain for the service account,// for example:https://www.googleapis.com/auth/devstorage.full_controlScopes []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:"-"`// NullFields is a list of field names (e.g. "Email") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}ServiceAccount: A Compute Engine service account, identical to theCompute Engine resource.
func (*ServiceAccount)MarshalJSON¶
func (s *ServiceAccount) MarshalJSON() ([]byte,error)
typeTag¶
type Tag struct {// FingerPrint: The fingerprint of the tag. Required for updating the// list of tags.FingerPrintstring `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:"-"`// NullFields is a list of field names (e.g. "FingerPrint") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}Tag: A Compute Engine Instance tag, identical to the tags on thecorresponding Compute Engine Instance resource.
func (*Tag)MarshalJSON¶
typeTemplate¶
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.Versionstring `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:"-"`// NullFields is a list of field names (e.g. "Action") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}Template: The template used for creating replicas in the pool.
func (*Template)MarshalJSON¶
typeVmParams¶
type VmParams struct {// BaseInstanceName: Deprecated. Please use baseInstanceName instead.BaseInstanceNamestring `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.CanIpForwardbool `json:"canIpForward,omitempty"`// Description: An optional textual description of the instance.Descriptionstring `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).MachineTypestring `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"`OnHostMaintenancestring `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:"-"`// NullFields is a list of field names (e.g. "BaseInstanceName") to// include in API requests with the JSON null value. By default, fields// with empty values are omitted from API requests. However, any field// with an empty value appearing in NullFields will be sent to the// server as null. It is an error if a field in this list has a// non-empty value. This may be used to include null fields in Patch// requests.NullFields []string `json:"-"`}VmParams: Parameters for creating a Compute Engine Instance resource.Most fields are identical to the corresponding Compute Engineresource.