Documentation
¶
Overview ¶
Package deploymentmanager provides access to the Google Cloud Deployment Manager API V2.
See https://developers.google.com/deployment-manager/
Usage example:
import "google.golang.org/api/deploymentmanager/v2beta1" ... deploymentmanagerService, err := deploymentmanager.New(oauthHttpClient)
Index ¶
- Constants
- type Deployment
- type DeploymentsDeleteCall
- type DeploymentsGetCall
- type DeploymentsInsertCall
- type DeploymentsListCall
- func (c *DeploymentsListCall) Do() (*DeploymentsListResponse, error)
- func (c *DeploymentsListCall) Fields(s ...googleapi.Field) *DeploymentsListCall
- func (c *DeploymentsListCall) MaxResults(maxResults int64) *DeploymentsListCall
- func (c *DeploymentsListCall) PageToken(pageToken string) *DeploymentsListCall
- type DeploymentsListResponse
- type DeploymentsService
- func (r *DeploymentsService) Delete(project string, deployment string) *DeploymentsDeleteCall
- func (r *DeploymentsService) Get(project string, deployment string) *DeploymentsGetCall
- func (r *DeploymentsService) Insert(project string, deployment *Deployment) *DeploymentsInsertCall
- func (r *DeploymentsService) List(project string) *DeploymentsListCall
- type Manifest
- type ManifestsGetCall
- type ManifestsListCall
- type ManifestsListResponse
- type ManifestsService
- type Operation
- type OperationError
- type OperationErrorErrors
- type OperationWarnings
- type OperationWarningsData
- type OperationsGetCall
- type OperationsListCall
- type OperationsListResponse
- type OperationsService
- type Resource
- type ResourcesGetCall
- type ResourcesListCall
- type ResourcesListResponse
- type ResourcesService
- type Service
- type Type
- type TypesListCall
- type TypesListResponse
- type TypesService
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // 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" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Deployment ¶
type Deployment struct {
// Description: ! An optional user-provided description of the
// deployment.
Description string `json:"description,omitempty"`
// Id: [Output Only] Unique identifier for the resource; defined by the
// server.
Id uint64 `json:"id,omitempty,string"`
// Manifest: ! [Output Only] URL of the manifest representing the full
// configuration ! of this deployment.
Manifest string `json:"manifest,omitempty"`
// Name: ! The name of the deployment, which must be unique within the
// project.
Name string `json:"name,omitempty"`
// TargetConfig: ! [Input Only] The YAML configuration to use in
// processing this deployment. ! ! When you create a deployment, the
// server creates a new manifest with the ! given YAML configuration and
// sets the `manifest` property to the URL of ! the manifest resource.
TargetConfig string `json:"targetConfig,omitempty"`
}
type DeploymentsDeleteCall ¶
type DeploymentsDeleteCall struct {
// contains filtered or unexported fields
}
func (*DeploymentsDeleteCall) Do ¶
func (c *DeploymentsDeleteCall) Do() (*Operation, error)
func (*DeploymentsDeleteCall) Fields ¶
func (c *DeploymentsDeleteCall) Fields(s ...googleapi.Field) *DeploymentsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type DeploymentsGetCall ¶
type DeploymentsGetCall struct {
// contains filtered or unexported fields
}
func (*DeploymentsGetCall) Do ¶
func (c *DeploymentsGetCall) Do() (*Deployment, error)
func (*DeploymentsGetCall) Fields ¶
func (c *DeploymentsGetCall) Fields(s ...googleapi.Field) *DeploymentsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type DeploymentsInsertCall ¶
type DeploymentsInsertCall struct {
// contains filtered or unexported fields
}
func (*DeploymentsInsertCall) Do ¶
func (c *DeploymentsInsertCall) Do() (*Operation, error)
func (*DeploymentsInsertCall) Fields ¶
func (c *DeploymentsInsertCall) Fields(s ...googleapi.Field) *DeploymentsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type DeploymentsListCall ¶
type DeploymentsListCall struct {
// contains filtered or unexported fields
}
func (*DeploymentsListCall) Do ¶
func (c *DeploymentsListCall) Do() (*DeploymentsListResponse, error)
func (*DeploymentsListCall) Fields ¶
func (c *DeploymentsListCall) Fields(s ...googleapi.Field) *DeploymentsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DeploymentsListCall) MaxResults ¶
func (c *DeploymentsListCall) MaxResults(maxResults int64) *DeploymentsListCall
MaxResults sets the optional parameter "maxResults": ! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)
func (*DeploymentsListCall) PageToken ¶
func (c *DeploymentsListCall) PageToken(pageToken string) *DeploymentsListCall
PageToken sets the optional parameter "pageToken": ! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.
type DeploymentsListResponse ¶
type DeploymentsListResponse struct {
// Deployments: ! The deployments contained in this response.
Deployments []*Deployment `json:"deployments,omitempty"`
// NextPageToken: ! A token used to continue a truncated list request.
NextPageToken string `json:"nextPageToken,omitempty"`
}
type DeploymentsService ¶
type DeploymentsService struct {
// contains filtered or unexported fields
}
func NewDeploymentsService ¶
func NewDeploymentsService(s *Service) *DeploymentsService
func (*DeploymentsService) Delete ¶
func (r *DeploymentsService) Delete(project string, deployment string) *DeploymentsDeleteCall
Delete: ! Deletes a deployment and all of the resources in the deployment.
func (*DeploymentsService) Get ¶
func (r *DeploymentsService) Get(project string, deployment string) *DeploymentsGetCall
Get: ! Gets information about a specific deployment.
func (*DeploymentsService) Insert ¶
func (r *DeploymentsService) Insert(project string, deployment *Deployment) *DeploymentsInsertCall
Insert: ! Creates a deployment and all of the resources described by the ! deployment manifest.
func (*DeploymentsService) List ¶
func (r *DeploymentsService) List(project string) *DeploymentsListCall
List: ! Lists all deployments for a given project.
type Manifest ¶
type Manifest struct {
// Config: v2beta1: YAML with config - described above v2beta2: YAML +
// templates. ! The YAML configuration for this manifest.
Config string `json:"config,omitempty"`
// EvaluatedConfig: ! [Output Only] The fully-expanded configuration
// file, including any ! templates and references.
EvaluatedConfig string `json:"evaluatedConfig,omitempty"`
// Id: [Output Only] Unique identifier for the resource; defined by the
// server.
Id uint64 `json:"id,omitempty,string"`
// Name: ! [Output Only] The name of the manifest.
Name string `json:"name,omitempty"`
// SelfLink: [Output Only] Self link for the manifest.
SelfLink string `json:"selfLink,omitempty"`
}
type ManifestsGetCall ¶
type ManifestsGetCall struct {
// contains filtered or unexported fields
}
func (*ManifestsGetCall) Do ¶
func (c *ManifestsGetCall) Do() (*Manifest, error)
func (*ManifestsGetCall) Fields ¶
func (c *ManifestsGetCall) Fields(s ...googleapi.Field) *ManifestsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ManifestsListCall ¶
type ManifestsListCall struct {
// contains filtered or unexported fields
}
func (*ManifestsListCall) Do ¶
func (c *ManifestsListCall) Do() (*ManifestsListResponse, error)
func (*ManifestsListCall) Fields ¶
func (c *ManifestsListCall) Fields(s ...googleapi.Field) *ManifestsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ManifestsListCall) MaxResults ¶
func (c *ManifestsListCall) MaxResults(maxResults int64) *ManifestsListCall
MaxResults sets the optional parameter "maxResults": ! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)
func (*ManifestsListCall) PageToken ¶
func (c *ManifestsListCall) PageToken(pageToken string) *ManifestsListCall
PageToken sets the optional parameter "pageToken": ! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.
type ManifestsListResponse ¶
type ManifestsService ¶
type ManifestsService struct {
// contains filtered or unexported fields
}
func NewManifestsService ¶
func NewManifestsService(s *Service) *ManifestsService
func (*ManifestsService) Get ¶
func (r *ManifestsService) Get(project string, deployment string, manifest string) *ManifestsGetCall
Get: ! Gets information about a specific manifest.
func (*ManifestsService) List ¶
func (r *ManifestsService) List(project string, deployment string) *ManifestsListCall
List: ! Lists all manifests for a given deployment.
type Operation ¶
type Operation struct {
// CreationTimestamp: ! [Output Only] Creation timestamp in RFC3339 text
// format.
CreationTimestamp string `json:"creationTimestamp,omitempty"`
// EndTime: ! [Output Only] The time that this operation was completed.
// This is in ! RFC3339 format.
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: ! [Output Only] If operation fails, the HTTP error
// message returned, ! e.g. NOT FOUND.
HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
// HttpErrorStatusCode: ! [Output Only] If operation fails, the HTTP
// error status code returned, ! e.g. 404.
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"`
// Name: ! [Output Only] Name of the operation.
Name string `json:"name,omitempty"`
// OperationType: ! [Output Only] Type of the operation. Examples
// include "insert", or ! "delete"
OperationType string `json:"operationType,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 operation will ! be complete. This number should be
// monotonically increasing as the ! operation progresses.
Progress int64 `json:"progress,omitempty"`
// SelfLink: [Output Only] Self link for the manifest.
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.
TargetLink string `json:"targetLink,omitempty"`
// User: ! [Output Only] User who requested the operation, for example !
// "user@example.com"
User string `json:"user,omitempty"`
// Warnings: ! [Output Only] If warning messages generated during
// processing of this ! operation, this field will be populated.
Warnings []*OperationWarnings `json:"warnings,omitempty"`
}
type OperationError ¶
type OperationError struct {
// Errors: ! The array of errors encountered while processing this
// operation.
Errors []*OperationErrorErrors `json:"errors,omitempty"`
}
type OperationErrorErrors ¶
type OperationErrorErrors struct {
// Code: ! The error type identifier for this error.
Code string `json:"code,omitempty"`
// Location: ! Indicates the field in the request which caused the
// error. ! This property is optional.
Location string `json:"location,omitempty"`
// Message: ! An optional, human-readable error message.
Message string `json:"message,omitempty"`
}
type OperationWarnings ¶
type OperationWarnings struct {
// Code: ! The warning type identifier for this warning.
Code interface{} `json:"code,omitempty"`
// Data: ! Metadata for this warning in 'key: value' format.
Data []*OperationWarningsData `json:"data,omitempty"`
// Message: ! Optional human-readable details for this warning.
Message string `json:"message,omitempty"`
}
type OperationWarningsData ¶
type OperationsGetCall ¶
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (*OperationsGetCall) Do ¶
func (c *OperationsGetCall) Do() (*Operation, error)
func (*OperationsGetCall) Fields ¶
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type OperationsListCall ¶
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (*OperationsListCall) Do ¶
func (c *OperationsListCall) Do() (*OperationsListResponse, error)
func (*OperationsListCall) Fields ¶
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsListCall) MaxResults ¶
func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall
MaxResults sets the optional parameter "maxResults": ! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)
func (*OperationsListCall) PageToken ¶
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": ! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.
type OperationsListResponse ¶
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Get ¶
func (r *OperationsService) Get(project string, operation string) *OperationsGetCall
Get: ! Gets information about a specific Operation.
func (*OperationsService) List ¶
func (r *OperationsService) List(project string) *OperationsListCall
List: ! Lists all Operations for a project.
type Resource ¶
type Resource struct {
// Errors: ! [Output Only] A list of any errors that occurred during
// deployment.
Errors []string `json:"errors,omitempty"`
// Id: [Output Only] Unique identifier for the resource; defined by the
// server.
Id uint64 `json:"id,omitempty,string"`
// Intent: ! [Output Only] The intended state of the resource.
Intent string `json:"intent,omitempty"`
// Manifest: ! [Output Only] URL of the manifest representing the
// current configuration ! of this resource.
Manifest string `json:"manifest,omitempty"`
// Name: ! [Output Only] The name of the resource as it appears in the
// YAML config.
Name string `json:"name,omitempty"`
// State: ! [Output Only] The state of the resource.
State string `json:"state,omitempty"`
// Type: ! [Output Only] The type of the resource, for example !
// ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
Type string `json:"type,omitempty"`
// Url: ! [Output Only] The URL of the actual resource.
Url string `json:"url,omitempty"`
}
type ResourcesGetCall ¶
type ResourcesGetCall struct {
// contains filtered or unexported fields
}
func (*ResourcesGetCall) Do ¶
func (c *ResourcesGetCall) Do() (*Resource, error)
func (*ResourcesGetCall) Fields ¶
func (c *ResourcesGetCall) Fields(s ...googleapi.Field) *ResourcesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ResourcesListCall ¶
type ResourcesListCall struct {
// contains filtered or unexported fields
}
func (*ResourcesListCall) Do ¶
func (c *ResourcesListCall) Do() (*ResourcesListResponse, error)
func (*ResourcesListCall) Fields ¶
func (c *ResourcesListCall) Fields(s ...googleapi.Field) *ResourcesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ResourcesListCall) MaxResults ¶
func (c *ResourcesListCall) MaxResults(maxResults int64) *ResourcesListCall
MaxResults sets the optional parameter "maxResults": ! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)
func (*ResourcesListCall) PageToken ¶
func (c *ResourcesListCall) PageToken(pageToken string) *ResourcesListCall
PageToken sets the optional parameter "pageToken": ! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.
type ResourcesListResponse ¶
type ResourcesService ¶
type ResourcesService struct {
// contains filtered or unexported fields
}
func NewResourcesService ¶
func NewResourcesService(s *Service) *ResourcesService
func (*ResourcesService) Get ¶
func (r *ResourcesService) Get(project string, deployment string, resource string) *ResourcesGetCall
Get: ! Gets information about a single resource.
func (*ResourcesService) List ¶
func (r *ResourcesService) List(project string, deployment string) *ResourcesListCall
List: ! Lists all resources in a given deployment.
type Service ¶
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Deployments *DeploymentsService
Manifests *ManifestsService
Operations *OperationsService
Resources *ResourcesService
Types *TypesService
// contains filtered or unexported fields
}
type TypesListCall ¶
type TypesListCall struct {
// contains filtered or unexported fields
}
func (*TypesListCall) Do ¶
func (c *TypesListCall) Do() (*TypesListResponse, error)
func (*TypesListCall) Fields ¶
func (c *TypesListCall) Fields(s ...googleapi.Field) *TypesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TypesListCall) MaxResults ¶
func (c *TypesListCall) MaxResults(maxResults int64) *TypesListCall
MaxResults sets the optional parameter "maxResults": ! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)
func (*TypesListCall) PageToken ¶
func (c *TypesListCall) PageToken(pageToken string) *TypesListCall
PageToken sets the optional parameter "pageToken": ! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.
type TypesListResponse ¶
type TypesListResponse struct {
// Types: ! Types supported by Deployment Manager
Types []*Type `json:"types,omitempty"`
}
type TypesService ¶
type TypesService struct {
// contains filtered or unexported fields
}
func NewTypesService ¶
func NewTypesService(s *Service) *TypesService
func (*TypesService) List ¶
func (r *TypesService) List(project string) *TypesListCall
List: ! Lists all Types for Deployment Manager.