Documentation ¶
Overview ¶
Package replicapoolupdater provides access to the Google Compute Engine Instance Group Updater API.
Usage example:
import "google.golang.org/api/replicapoolupdater/v1beta1" ... replicapoolupdaterService, err := replicapoolupdater.New(oauthHttpClient)
Index ¶
- Constants
- type InstanceUpdate
- type InstanceUpdateError
- type InstanceUpdateErrorErrors
- type InstanceUpdateList
- type Operation
- type OperationError
- type OperationErrorErrors
- type OperationWarnings
- type OperationWarningsData
- type RollingUpdate
- type RollingUpdateList
- type RollingUpdatePolicy
- type RollingUpdatePolicyCanary
- type RollingUpdatesCancelCall
- type RollingUpdatesGetCall
- type RollingUpdatesInsertCall
- type RollingUpdatesListCall
- func (c *RollingUpdatesListCall) Do() (*RollingUpdateList, error)
- func (c *RollingUpdatesListCall) Fields(s ...googleapi.Field) *RollingUpdatesListCall
- func (c *RollingUpdatesListCall) Filter(filter string) *RollingUpdatesListCall
- func (c *RollingUpdatesListCall) InstanceGroupManager(instanceGroupManager string) *RollingUpdatesListCall
- func (c *RollingUpdatesListCall) MaxResults(maxResults int64) *RollingUpdatesListCall
- func (c *RollingUpdatesListCall) PageToken(pageToken string) *RollingUpdatesListCall
- type RollingUpdatesListInstanceUpdatesCall
- func (c *RollingUpdatesListInstanceUpdatesCall) Do() (*InstanceUpdateList, error)
- func (c *RollingUpdatesListInstanceUpdatesCall) Fields(s ...googleapi.Field) *RollingUpdatesListInstanceUpdatesCall
- func (c *RollingUpdatesListInstanceUpdatesCall) Filter(filter string) *RollingUpdatesListInstanceUpdatesCall
- func (c *RollingUpdatesListInstanceUpdatesCall) MaxResults(maxResults int64) *RollingUpdatesListInstanceUpdatesCall
- func (c *RollingUpdatesListInstanceUpdatesCall) PageToken(pageToken string) *RollingUpdatesListInstanceUpdatesCall
- type RollingUpdatesPauseCall
- type RollingUpdatesResumeCall
- type RollingUpdatesRollbackCall
- type RollingUpdatesService
- func (r *RollingUpdatesService) Cancel(project string, zone string, rollingUpdate string) *RollingUpdatesCancelCall
- func (r *RollingUpdatesService) Get(project string, zone string, rollingUpdate string) *RollingUpdatesGetCall
- func (r *RollingUpdatesService) Insert(project string, zone string, rollingupdate *RollingUpdate) *RollingUpdatesInsertCall
- func (r *RollingUpdatesService) List(project string, zone string) *RollingUpdatesListCall
- func (r *RollingUpdatesService) ListInstanceUpdates(project string, zone string, rollingUpdate string) *RollingUpdatesListInstanceUpdatesCall
- func (r *RollingUpdatesService) Pause(project string, zone string, rollingUpdate string) *RollingUpdatesPauseCall
- func (r *RollingUpdatesService) Resume(project string, zone string, rollingUpdate string) *RollingUpdatesResumeCall
- func (r *RollingUpdatesService) Rollback(project string, zone string, rollingUpdate string) *RollingUpdatesRollbackCall
- type Service
- type ZoneOperationsGetCall
- type ZoneOperationsService
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // 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 InstanceUpdate ¶
type InstanceUpdate struct { // Error: Errors that occurred during the instance update. Setting // (api.field).field_number manually is a workaround for b/16512602. Error *InstanceUpdateError `json:"error,omitempty"` // Instance: URL of the instance being updated. Instance string `json:"instance,omitempty"` // Status: Status of the instance update. Possible values are: // - // "PENDING": The instance update is pending execution. // - // "ROLLING_FORWARD": The instance update is going forward. // - // "ROLLING_BACK": The instance update is being rolled back. // - // "PAUSED": The instance update is temporarily paused (inactive). // - // "ROLLED_OUT": The instance update is finished, the instance is // running the new template. // - "ROLLED_BACK": The instance update is // finished, the instance has been reverted to the previous template. // - // "CANCELLED": The instance update is paused and no longer can be // resumed, undefined in which template the instance is running. Status string `json:"status,omitempty"` }
type InstanceUpdateError ¶
type InstanceUpdateError struct { // Errors: [Output Only] The array of errors encountered while // processing this operation. Errors []*InstanceUpdateErrorErrors `json:"errors,omitempty"` }
type InstanceUpdateErrorErrors ¶
type InstanceUpdateErrorErrors struct { // Code: [Output Only] The error type identifier for this error. Code string `json:"code,omitempty"` // Location: [Output Only] Indicates the field in the request which // caused the error. This property is optional. Location string `json:"location,omitempty"` // Message: [Output Only] An optional, human-readable error message. Message string `json:"message,omitempty"` }
type InstanceUpdateList ¶
type InstanceUpdateList struct { // Items: Collection of requested instance updates. Items []*InstanceUpdate `json:"items,omitempty"` // Kind: [Output Only] Type of the resource. Kind string `json:"kind,omitempty"` // NextPageToken: A token used to continue a truncated list request. NextPageToken string `json:"nextPageToken,omitempty"` // SelfLink: [Output Only] The fully qualified URL for the resource. SelfLink string `json:"selfLink,omitempty"` }
type Operation ¶
type Operation struct { ClientOperationId string `json:"clientOperationId,omitempty"` // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text // format (output only). CreationTimestamp string `json:"creationTimestamp,omitempty"` EndTime string `json:"endTime,omitempty"` // Error: [Output Only] If errors occurred during processing of this // operation, this field will be populated. Error *OperationError `json:"error,omitempty"` HttpErrorMessage string `json:"httpErrorMessage,omitempty"` HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"` // Id: [Output Only] Unique identifier for the resource; defined by the // server. Id uint64 `json:"id,omitempty,string"` // InsertTime: [Output Only] The time that this operation was requested. // This is in RFC 3339 format. InsertTime string `json:"insertTime,omitempty"` // Kind: [Output Only] Type of the resource. Always kind#operation for // Operation resources. Kind string `json:"kind,omitempty"` // Name: [Output Only] Name of the resource (output only). Name string `json:"name,omitempty"` OperationType string `json:"operationType,omitempty"` Progress int64 `json:"progress,omitempty"` // Region: [Output Only] URL of the region where the operation resides // (output only). Region string `json:"region,omitempty"` // SelfLink: [Output Only] Server defined URL for the resource. SelfLink string `json:"selfLink,omitempty"` // StartTime: [Output Only] The time that this operation was started by // the server. This is in RFC 3339 format. StartTime string `json:"startTime,omitempty"` // Status: [Output Only] Status of the operation. Can be one of the // following: "PENDING", "RUNNING", or "DONE". Status string `json:"status,omitempty"` // StatusMessage: [Output Only] An optional textual description of the // current status of the operation. StatusMessage string `json:"statusMessage,omitempty"` // TargetId: [Output Only] Unique target id which identifies a // particular incarnation of the target. TargetId uint64 `json:"targetId,omitempty,string"` // TargetLink: [Output Only] URL of the resource the operation is // mutating (output only). TargetLink string `json:"targetLink,omitempty"` User string `json:"user,omitempty"` Warnings []*OperationWarnings `json:"warnings,omitempty"` // Zone: [Output Only] URL of the zone where the operation resides // (output only). Zone string `json:"zone,omitempty"` }
type OperationError ¶
type OperationError struct { // Errors: [Output Only] The array of errors encountered while // processing this operation. Errors []*OperationErrorErrors `json:"errors,omitempty"` }
type OperationErrorErrors ¶
type OperationErrorErrors struct { // Code: [Output Only] The error type identifier for this error. Code string `json:"code,omitempty"` // Location: [Output Only] Indicates the field in the request which // caused the error. This property is optional. Location string `json:"location,omitempty"` // Message: [Output Only] An optional, human-readable error message. Message string `json:"message,omitempty"` }
type OperationWarnings ¶
type OperationWarnings struct { // Code: [Output only] The warning type identifier for this warning. Code string `json:"code,omitempty"` // Data: [Output only] Metadata for this warning in key:value format. Data []*OperationWarningsData `json:"data,omitempty"` // Message: [Output only] Optional human-readable details for this // warning. Message string `json:"message,omitempty"` }
type OperationWarningsData ¶
type RollingUpdate ¶
type RollingUpdate struct { // ActionType: Action to be performed for each instance. Possible values // are: // - "RECREATE": Instance will be recreated. Only for managed // instance groups. // - "REBOOT": Soft reboot will be performed on an // instance. Only for non-managed instance groups. ActionType string `json:"actionType,omitempty"` // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text // format. CreationTimestamp string `json:"creationTimestamp,omitempty"` // Description: An optional textual description of the resource; // provided by the client when the resource is created. Description string `json:"description,omitempty"` // Id: [Output Only] Unique identifier for the resource; defined by the // server. Id string `json:"id,omitempty"` // InstanceGroup: URL of an instance group being updated. Exactly one of // instance_group_manager and instance_group must be set. InstanceGroup string `json:"instanceGroup,omitempty"` // InstanceGroupManager: URL of an instance group manager being updated. // Exactly one of instance_group_manager and instance_group must be set. InstanceGroupManager string `json:"instanceGroupManager,omitempty"` // InstanceTemplate: URL of an instance template to apply. InstanceTemplate string `json:"instanceTemplate,omitempty"` // Kind: [Output Only] Type of the resource. Kind string `json:"kind,omitempty"` // Policy: Parameters of the update process. Setting // (api.field).field_number manually is a workaround for b/16512602. Policy *RollingUpdatePolicy `json:"policy,omitempty"` // Progress: [Output Only] An optional progress indicator that ranges // from 0 to 100. There is no requirement that this be linear or support // any granularity of operations. This should not be used to guess at // when the update will be complete. This number should be monotonically // increasing as the update progresses. Progress int64 `json:"progress,omitempty"` // SelfLink: [Output Only] The fully qualified URL for the resource. SelfLink string `json:"selfLink,omitempty"` // Status: [Output Only] Status of the update. Possible values are: // - // "ROLLING_FORWARD": The update is going forward. // - "ROLLING_BACK": // The update is being rolled back. // - "PAUSED": The update is // temporarily paused (inactive). // - "ROLLED_OUT": The update is // finished, all instances have been updated successfully. // - // "ROLLED_BACK": The update is finished, all instances have been // reverted to the previous template. // - "CANCELLED": The update is // paused and no longer can be resumed, undefined how many instances are // running in which template. Status string `json:"status,omitempty"` // StatusMessage: [Output Only] An optional textual description of the // current status of the update. StatusMessage string `json:"statusMessage,omitempty"` // User: [Output Only] User who requested the update, for example: // user@example.com. User string `json:"user,omitempty"` }
type RollingUpdateList ¶
type RollingUpdateList struct { // Items: Collection of requested updates. Items []*RollingUpdate `json:"items,omitempty"` // Kind: [Output Only] Type of the resource. Kind string `json:"kind,omitempty"` // NextPageToken: A token used to continue a truncated list request. NextPageToken string `json:"nextPageToken,omitempty"` // SelfLink: [Output Only] The fully qualified URL for the resource. SelfLink string `json:"selfLink,omitempty"` }
type RollingUpdatePolicy ¶
type RollingUpdatePolicy struct { // Canary: Parameters of a canary phase. If absent, canary will NOT be // performed. Canary *RollingUpdatePolicyCanary `json:"canary,omitempty"` // MaxNumConcurrentInstances: Maximum number of instances that can be // updated simultaneously (concurrently). An update of an instance // starts when the instance is about to be restarted and finishes after // the instance has been restarted and the sleep period (defined by // sleepAfterInstanceRestartSec) has passed. MaxNumConcurrentInstances int64 `json:"maxNumConcurrentInstances,omitempty"` // SleepAfterInstanceRestartSec: The number of seconds to wait between // when the instance has been successfully updated and restarted, to // when it is marked as done. SleepAfterInstanceRestartSec int64 `json:"sleepAfterInstanceRestartSec,omitempty"` }
type RollingUpdatePolicyCanary ¶
type RollingUpdatePolicyCanary struct { // NumInstances: Number of instances updated as a part of canary phase. // If absent, the default number of instances will be used. NumInstances int64 `json:"numInstances,omitempty"` }
type RollingUpdatesCancelCall ¶
type RollingUpdatesCancelCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesCancelCall) Do ¶
func (c *RollingUpdatesCancelCall) Do() (*Operation, error)
func (*RollingUpdatesCancelCall) Fields ¶
func (c *RollingUpdatesCancelCall) Fields(s ...googleapi.Field) *RollingUpdatesCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type RollingUpdatesGetCall ¶
type RollingUpdatesGetCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesGetCall) Do ¶
func (c *RollingUpdatesGetCall) Do() (*RollingUpdate, error)
func (*RollingUpdatesGetCall) Fields ¶
func (c *RollingUpdatesGetCall) Fields(s ...googleapi.Field) *RollingUpdatesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type RollingUpdatesInsertCall ¶
type RollingUpdatesInsertCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesInsertCall) Do ¶
func (c *RollingUpdatesInsertCall) Do() (*Operation, error)
func (*RollingUpdatesInsertCall) Fields ¶
func (c *RollingUpdatesInsertCall) Fields(s ...googleapi.Field) *RollingUpdatesInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type RollingUpdatesListCall ¶
type RollingUpdatesListCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesListCall) Do ¶
func (c *RollingUpdatesListCall) Do() (*RollingUpdateList, error)
func (*RollingUpdatesListCall) Fields ¶
func (c *RollingUpdatesListCall) Fields(s ...googleapi.Field) *RollingUpdatesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RollingUpdatesListCall) Filter ¶
func (c *RollingUpdatesListCall) Filter(filter string) *RollingUpdatesListCall
Filter sets the optional parameter "filter": Filter expression for filtering listed resources.
func (*RollingUpdatesListCall) InstanceGroupManager ¶
func (c *RollingUpdatesListCall) InstanceGroupManager(instanceGroupManager string) *RollingUpdatesListCall
InstanceGroupManager sets the optional parameter "instanceGroupManager": The name of the instance group manager used for filtering.
func (*RollingUpdatesListCall) MaxResults ¶
func (c *RollingUpdatesListCall) MaxResults(maxResults int64) *RollingUpdatesListCall
MaxResults sets the optional parameter "maxResults": Maximum count of results to be returned. Maximum value is 500 and default value is 500.
func (*RollingUpdatesListCall) PageToken ¶
func (c *RollingUpdatesListCall) PageToken(pageToken string) *RollingUpdatesListCall
PageToken sets the optional parameter "pageToken": Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
type RollingUpdatesListInstanceUpdatesCall ¶
type RollingUpdatesListInstanceUpdatesCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesListInstanceUpdatesCall) Do ¶
func (c *RollingUpdatesListInstanceUpdatesCall) Do() (*InstanceUpdateList, error)
func (*RollingUpdatesListInstanceUpdatesCall) Fields ¶
func (c *RollingUpdatesListInstanceUpdatesCall) Fields(s ...googleapi.Field) *RollingUpdatesListInstanceUpdatesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RollingUpdatesListInstanceUpdatesCall) Filter ¶
func (c *RollingUpdatesListInstanceUpdatesCall) Filter(filter string) *RollingUpdatesListInstanceUpdatesCall
Filter sets the optional parameter "filter": Filter expression for filtering listed resources.
func (*RollingUpdatesListInstanceUpdatesCall) MaxResults ¶
func (c *RollingUpdatesListInstanceUpdatesCall) MaxResults(maxResults int64) *RollingUpdatesListInstanceUpdatesCall
MaxResults sets the optional parameter "maxResults": Maximum count of results to be returned. Maximum value is 500 and default value is 500.
func (*RollingUpdatesListInstanceUpdatesCall) PageToken ¶
func (c *RollingUpdatesListInstanceUpdatesCall) PageToken(pageToken string) *RollingUpdatesListInstanceUpdatesCall
PageToken sets the optional parameter "pageToken": Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
type RollingUpdatesPauseCall ¶
type RollingUpdatesPauseCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesPauseCall) Do ¶
func (c *RollingUpdatesPauseCall) Do() (*Operation, error)
func (*RollingUpdatesPauseCall) Fields ¶
func (c *RollingUpdatesPauseCall) Fields(s ...googleapi.Field) *RollingUpdatesPauseCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type RollingUpdatesResumeCall ¶
type RollingUpdatesResumeCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesResumeCall) Do ¶
func (c *RollingUpdatesResumeCall) Do() (*Operation, error)
func (*RollingUpdatesResumeCall) Fields ¶
func (c *RollingUpdatesResumeCall) Fields(s ...googleapi.Field) *RollingUpdatesResumeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type RollingUpdatesRollbackCall ¶
type RollingUpdatesRollbackCall struct {
// contains filtered or unexported fields
}
func (*RollingUpdatesRollbackCall) Do ¶
func (c *RollingUpdatesRollbackCall) Do() (*Operation, error)
func (*RollingUpdatesRollbackCall) Fields ¶
func (c *RollingUpdatesRollbackCall) Fields(s ...googleapi.Field) *RollingUpdatesRollbackCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type RollingUpdatesService ¶
type RollingUpdatesService struct {
// contains filtered or unexported fields
}
func NewRollingUpdatesService ¶
func NewRollingUpdatesService(s *Service) *RollingUpdatesService
func (*RollingUpdatesService) Cancel ¶
func (r *RollingUpdatesService) Cancel(project string, zone string, rollingUpdate string) *RollingUpdatesCancelCall
Cancel: Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#cancelrollingupdate
func (*RollingUpdatesService) Get ¶
func (r *RollingUpdatesService) Get(project string, zone string, rollingUpdate string) *RollingUpdatesGetCall
Get: Returns information about an update. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#getlistrollingupdate
func (*RollingUpdatesService) Insert ¶
func (r *RollingUpdatesService) Insert(project string, zone string, rollingupdate *RollingUpdate) *RollingUpdatesInsertCall
Insert: Inserts and starts a new update. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#starting_an_update
func (*RollingUpdatesService) List ¶
func (r *RollingUpdatesService) List(project string, zone string) *RollingUpdatesListCall
List: Lists recent updates for a given managed instance group, in reverse chronological order and paginated format. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#getlistrollingupdate
func (*RollingUpdatesService) ListInstanceUpdates ¶
func (r *RollingUpdatesService) ListInstanceUpdates(project string, zone string, rollingUpdate string) *RollingUpdatesListInstanceUpdatesCall
ListInstanceUpdates: Lists the current status for each instance within a given update. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#getlistrollingupdate
func (*RollingUpdatesService) Pause ¶
func (r *RollingUpdatesService) Pause(project string, zone string, rollingUpdate string) *RollingUpdatesPauseCall
Pause: Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#pausing_a_rolling_update
func (*RollingUpdatesService) Resume ¶
func (r *RollingUpdatesService) Resume(project string, zone string, rollingUpdate string) *RollingUpdatesResumeCall
Resume: Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#continuerollingupdate
func (*RollingUpdatesService) Rollback ¶
func (r *RollingUpdatesService) Rollback(project string, zone string, rollingUpdate string) *RollingUpdatesRollbackCall
Rollback: Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK. For details, see https://cloud.google.com/compute/docs/instance-groups/manager/#rollingbackupdate
type Service ¶
type Service struct { BasePath string // API endpoint base URL RollingUpdates *RollingUpdatesService ZoneOperations *ZoneOperationsService // contains filtered or unexported fields }
type ZoneOperationsGetCall ¶
type ZoneOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ZoneOperationsGetCall) Do ¶
func (c *ZoneOperationsGetCall) Do() (*Operation, error)
func (*ZoneOperationsGetCall) Fields ¶
func (c *ZoneOperationsGetCall) Fields(s ...googleapi.Field) *ZoneOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ZoneOperationsService ¶
type ZoneOperationsService struct {
// contains filtered or unexported fields
}
func NewZoneOperationsService ¶
func NewZoneOperationsService(s *Service) *ZoneOperationsService
func (*ZoneOperationsService) Get ¶
func (r *ZoneOperationsService) Get(project string, zone string, operation string) *ZoneOperationsGetCall
Get: Retrieves the specified zone-specific operation resource.