OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View your data across Google Cloud services and see the email address of
// your Google Account
CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
// View and manage your Google Cloud Platform management resources and
// deployment status information
NdevCloudmanScope = "https://www.googleapis.com/auth/ndev.cloudman"
// View your Google Cloud Platform management resources and deployment status
// information
NdevCloudmanReadonlyScope = "https://www.googleapis.com/auth/ndev.cloudman.readonly"
)
AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
type AuditConfig struct {
// AuditLogConfigs: The configuration for logging of each type of permission.
AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
// Service: Specifies a service that will be enabled for audit logging. For
// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`
// is a special value that covers all services.
Service string `json:"service,omitempty"`
// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AuditConfig) MarshalJSON() ([]byte, error)
AuditLogConfig: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
type AuditLogConfig struct {
// ExemptedMembers: Specifies the identities that do not cause logging for this
// type of permission. Follows the same format of Binding.members.
ExemptedMembers []string `json:"exemptedMembers,omitempty"`
// LogType: The log type that this config enables.
//
// Possible values:
// "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
// "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
// "DATA_WRITE" - Data writes. Example: CloudSQL Users create
// "DATA_READ" - Data reads. Example: CloudSQL Users list
LogType string `json:"logType,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExemptedMembers") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AuditLogConfig) MarshalJSON() ([]byte, error)
Binding: Associates `members`, or principals, with a `role`.
type Binding struct {
// Condition: The condition that is associated with this binding. If the
// condition evaluates to `true`, then this binding applies to the current
// request. If the condition evaluates to `false`, then this binding does not
// apply to the current request. However, a different role binding might grant
// the same role to one or more of the principals in this binding. To learn
// which resources support conditions in their IAM policies, see the IAM
// documentation
// (https://cloud.google.com/iam/help/conditions/resource-policies).
Condition *Expr `json:"condition,omitempty"`
// Members: Specifies the principals requesting access for a Google Cloud
// resource. `members` can have the following values: * `allUsers`: A special
// identifier that represents anyone who is on the internet; with or without a
// Google account. * `allAuthenticatedUsers`: A special identifier that
// represents anyone who is authenticated with a Google account or a service
// account. Does not include identities that come from external identity
// providers (IdPs) through identity federation. * `user:{emailid}`: An email
// address that represents a specific Google account. For example,
// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
// represents a Google service account. For example,
// `my-other-app@appspot.gserviceaccount.com`. *
// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
// identifier for a Kubernetes service account
// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
// `group:{emailid}`: An email address that represents a Google group. For
// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
// (primary) that represents all the users of that domain. For example,
// `google.com` or `example.com`. *
// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
// ject/{subject_attribute_value}`: A single identity in a workforce identity
// pool. *
// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
// group/{group_id}`: All workforce identities in a group. *
// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
// a specific attribute value. *
// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
// *`: All identities in a workforce identity pool. *
// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
// identity in a workload identity pool. *
// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
// group. *
// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
// `: All identities in a workload identity pool with a certain attribute. *
// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
// unique identifier) representing a user that has been recently deleted. For
// example, `alice@example.com?uid=123456789012345678901`. If the user is
// recovered, this value reverts to `user:{emailid}` and the recovered user
// retains the role in the binding. *
// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
// unique identifier) representing a service account that has been recently
// deleted. For example,
// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
// service account is undeleted, this value reverts to
// `serviceAccount:{emailid}` and the undeleted service account retains the
// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
// address (plus unique identifier) representing a Google group that has been
// recently deleted. For example,
// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
// this value reverts to `group:{emailid}` and the recovered group retains the
// role in the binding. *
// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
// workforce identity pool. For example,
// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
// ol-id/subject/my-subject-attribute-value`.
Members []string `json:"members,omitempty"`
// Role: Role that is assigned to the list of `members`, or principals. For
// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
// of the IAM roles and permissions, see the IAM documentation
// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
// available pre-defined roles, see here
// (https://cloud.google.com/iam/docs/understanding-roles).
Role string `json:"role,omitempty"`
// ForceSendFields is a list of field names (e.g. "Condition") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Condition") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Binding) MarshalJSON() ([]byte, error)
type BulkInsertOperationStatus struct {
// CreatedVmCount: [Output Only] Count of VMs successfully created so far.
CreatedVmCount int64 `json:"createdVmCount,omitempty"`
// DeletedVmCount: [Output Only] Count of VMs that got deleted during rollback.
DeletedVmCount int64 `json:"deletedVmCount,omitempty"`
// FailedToCreateVmCount: [Output Only] Count of VMs that started creating but
// encountered an error.
FailedToCreateVmCount int64 `json:"failedToCreateVmCount,omitempty"`
// Status: [Output Only] Creation status of BulkInsert operation - information
// if the flow is rolling forward or rolling back.
//
// Possible values:
// "STATUS_UNSPECIFIED"
// "CREATING" - Rolling forward - creating VMs.
// "ROLLING_BACK" - Rolling back - cleaning up after an error.
// "DONE" - Done
Status string `json:"status,omitempty"`
// TargetVmCount: [Output Only] Count of VMs originally planned to be created.
TargetVmCount int64 `json:"targetVmCount,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreatedVmCount") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreatedVmCount") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BulkInsertOperationStatus) MarshalJSON() ([]byte, error)
type ConfigFile struct {
// Content: The contents of the file.
Content string `json:"content,omitempty"`
// ForceSendFields is a list of field names (e.g. "Content") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Content") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ConfigFile) MarshalJSON() ([]byte, error)
type Deployment struct {
// Description: An optional user-provided description of the deployment.
Description string `json:"description,omitempty"`
// Fingerprint: Provides a fingerprint to use in requests to modify a
// deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A
// fingerprint is a randomly generated value that must be provided with
// `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic
// locking. This ensures optimistic concurrency so that only one request
// happens at a time. The fingerprint is initially generated by Deployment
// Manager and changes after every request to modify data. To get the latest
// fingerprint value, perform a `get()` request to a deployment.
Fingerprint string `json:"fingerprint,omitempty"`
Id uint64 `json:"id,omitempty,string"`
// InsertTime: Output only. Creation timestamp in RFC3339 text format.
InsertTime string `json:"insertTime,omitempty"`
// Labels: Map of One Platform labels; provided by the client when the resource
// is created or updated. Specifically: Label keys must be between 1 and 63
// characters long and must conform to the following regular expression: `a-z
// ([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long
// and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
Labels []*DeploymentLabelEntry `json:"labels,omitempty"`
// Manifest: Output only. URL of the manifest representing the last manifest
// that was successfully deployed. If no manifest has been successfully
// deployed, this field will be absent.
Manifest string `json:"manifest,omitempty"`
// Name: Name of the resource; provided by the client when the resource is
// created. The name must be 1-63 characters long, and comply with RFC1035.
// Specifically, the name must be 1-63 characters long and match the regular
// expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must
// be a lowercase letter, and all following characters must be a dash,
// lowercase letter, or digit, except the last character, which cannot be a
// dash.
Name string `json:"name,omitempty"`
// Operation: Output only. The Operation that most recently ran, or is
// currently running, on this deployment.
Operation *Operation `json:"operation,omitempty"`
// SelfLink: Output only. Server defined URL for the resource.
SelfLink string `json:"selfLink,omitempty"`
// Target: [Input Only] The parameters that define your deployment, including
// the deployment configuration and relevant templates.
Target *TargetConfiguration `json:"target,omitempty"`
// Update: Output only. If Deployment Manager is currently updating or
// previewing an update to this deployment, the updated configuration appears
// here.
Update *DeploymentUpdate `json:"update,omitempty"`
// UpdateTime: Output only. Update timestamp in RFC3339 text format.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Deployment) MarshalJSON() ([]byte, error)
DeploymentLabelEntry: Label object for Deployments
type DeploymentLabelEntry struct {
// Key: Key of the label
Key string `json:"key,omitempty"`
// Value: Value of the label
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeploymentLabelEntry) MarshalJSON() ([]byte, error)
type DeploymentUpdate struct {
// Description: Output only. An optional user-provided description of the
// deployment after the current update has been applied.
Description string `json:"description,omitempty"`
// Labels: Map of One Platform labels; provided by the client when the resource
// is created or updated. Specifically: Label keys must be between 1 and 63
// characters long and must conform to the following regular expression: `a-z
// ([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long
// and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
Labels []*DeploymentUpdateLabelEntry `json:"labels,omitempty"`
// Manifest: Output only. URL of the manifest representing the update
// configuration of this deployment.
Manifest string `json:"manifest,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeploymentUpdate) MarshalJSON() ([]byte, error)
DeploymentUpdateLabelEntry: Label object for DeploymentUpdate
type DeploymentUpdateLabelEntry struct {
// Key: Key of the label
Key string `json:"key,omitempty"`
// Value: Value of the label
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeploymentUpdateLabelEntry) MarshalJSON() ([]byte, error)
type DeploymentsCancelPreviewCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsCancelPreviewCall) Context(ctx context.Context) *DeploymentsCancelPreviewCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsCancelPreviewCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "deploymentmanager.deployments.cancelPreview" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DeploymentsCancelPreviewCall) Fields(s ...googleapi.Field) *DeploymentsCancelPreviewCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DeploymentsCancelPreviewCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DeploymentsCancelPreviewRequest struct {
// Fingerprint: Specifies a fingerprint for `cancelPreview()` requests. A
// fingerprint is a randomly generated value that must be provided in
// `cancelPreview()` requests to perform optimistic locking. This ensures
// optimistic concurrency so that the deployment does not have conflicting
// requests (e.g. if someone attempts to make a new update request while
// another user attempts to cancel a preview, this would prevent one of the
// requests). The fingerprint is initially generated by Deployment Manager and
// changes after every request to modify a deployment. To get the latest
// fingerprint value, perform a `get()` request on the deployment.
Fingerprint string `json:"fingerprint,omitempty"`
// ForceSendFields is a list of field names (e.g. "Fingerprint") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeploymentsCancelPreviewRequest) MarshalJSON() ([]byte, error)
type DeploymentsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsDeleteCall) Context(ctx context.Context) *DeploymentsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsDeleteCall) DeletePolicy(deletePolicy string) *DeploymentsDeleteCall
DeletePolicy sets the optional parameter "deletePolicy": Sets the policy to use for deleting resources.
Possible values:
"DELETE" (default) "ABANDON"
func (c *DeploymentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "deploymentmanager.deployments.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *DeploymentsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DeploymentsGetCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsGetCall) Context(ctx context.Context) *DeploymentsGetCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsGetCall) Do(opts ...googleapi.CallOption) (*Deployment, error)
Do executes the "deploymentmanager.deployments.get" call. Any non-2xx status code is an error. Response headers are in either *Deployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *DeploymentsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DeploymentsGetCall) IfNoneMatch(entityTag string) *DeploymentsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type DeploymentsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsGetIamPolicyCall) Context(ctx context.Context) *DeploymentsGetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "deploymentmanager.deployments.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DeploymentsGetIamPolicyCall) Fields(s ...googleapi.Field) *DeploymentsGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DeploymentsGetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DeploymentsGetIamPolicyCall) IfNoneMatch(entityTag string) *DeploymentsGetIamPolicyCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *DeploymentsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *DeploymentsGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "optionsRequestedPolicyVersion": Requested IAM Policy version.
type DeploymentsInsertCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsInsertCall) Context(ctx context.Context) *DeploymentsInsertCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsInsertCall) CreatePolicy(createPolicy string) *DeploymentsInsertCall
CreatePolicy sets the optional parameter "createPolicy": Sets the policy to use for creating new resources.
Possible values:
"CREATE_OR_ACQUIRE" (default) "ACQUIRE"
func (c *DeploymentsInsertCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "deploymentmanager.deployments.insert" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *DeploymentsInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DeploymentsInsertCall) Preview(preview bool) *DeploymentsInsertCall
Preview sets the optional parameter "preview": If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the `update()` method or you can use the `cancelPreview()` method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
type DeploymentsListCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsListCall) Context(ctx context.Context) *DeploymentsListCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsListCall) Do(opts ...googleapi.CallOption) (*DeploymentsListResponse, error)
Do executes the "deploymentmanager.deployments.list" call. Any non-2xx status code is an error. Response headers are in either *DeploymentsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *DeploymentsListCall) Filter(filter string) *DeploymentsListCall
Filter sets the optional parameter "filter": A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal" `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
func (c *DeploymentsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DeploymentsListCall) IfNoneMatch(entityTag string) *DeploymentsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *DeploymentsListCall) MaxResults(maxResults int64) *DeploymentsListCall
MaxResults sets the optional parameter "maxResults": The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
func (c *DeploymentsListCall) OrderBy(orderBy string) *DeploymentsListCall
OrderBy sets the optional parameter "orderBy": Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc". This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
func (c *DeploymentsListCall) PageToken(pageToken string) *DeploymentsListCall
PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
func (c *DeploymentsListCall) Pages(ctx context.Context, f func(*DeploymentsListResponse) 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.
DeploymentsListResponse: A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
type DeploymentsListResponse struct {
// Deployments: Output only. The deployments contained in this response.
Deployments []*Deployment `json:"deployments,omitempty"`
// NextPageToken: Output only. A token used to continue a truncated list
// request.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Deployments") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Deployments") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeploymentsListResponse) MarshalJSON() ([]byte, error)
type DeploymentsPatchCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsPatchCall) Context(ctx context.Context) *DeploymentsPatchCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsPatchCall) CreatePolicy(createPolicy string) *DeploymentsPatchCall
CreatePolicy sets the optional parameter "createPolicy": Sets the policy to use for creating new resources.
Possible values:
"CREATE_OR_ACQUIRE" (default) "ACQUIRE"
func (c *DeploymentsPatchCall) DeletePolicy(deletePolicy string) *DeploymentsPatchCall
DeletePolicy sets the optional parameter "deletePolicy": Sets the policy to use for deleting resources.
Possible values:
"DELETE" (default) "ABANDON"
func (c *DeploymentsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "deploymentmanager.deployments.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DeploymentsPatchCall) Fields(s ...googleapi.Field) *DeploymentsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DeploymentsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DeploymentsPatchCall) Preview(preview bool) *DeploymentsPatchCall
Preview sets the optional parameter "preview": If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
type DeploymentsService struct {
// contains filtered or unexported fields
}
func NewDeploymentsService(s *Service) *DeploymentsService
func (r *DeploymentsService) CancelPreview(project string, deployment string, deploymentscancelpreviewrequest *DeploymentsCancelPreviewRequest) *DeploymentsCancelPreviewCall
CancelPreview: Cancels and removes the preview currently associated with the deployment.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
func (r *DeploymentsService) Delete(project string, deployment string) *DeploymentsDeleteCall
Delete: Deletes a deployment and all of the resources in the deployment.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
func (r *DeploymentsService) Get(project string, deployment string) *DeploymentsGetCall
Get: Gets information about a specific deployment.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
func (r *DeploymentsService) GetIamPolicy(project string, resource string) *DeploymentsGetIamPolicyCall
GetIamPolicy: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
- project: Project ID for this request. - resource: Name or id of the resource for this request.
func (r *DeploymentsService) Insert(project string, deployment *Deployment) *DeploymentsInsertCall
Insert: Creates a deployment and all of the resources described by the deployment manifest.
- project: The project ID for this request.
func (r *DeploymentsService) List(project string) *DeploymentsListCall
List: Lists all deployments for a given project.
- project: The project ID for this request.
func (r *DeploymentsService) Patch(project string, deployment string, deployment2 *Deployment) *DeploymentsPatchCall
Patch: Patches a deployment and all of the resources described by the deployment manifest.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
func (r *DeploymentsService) SetIamPolicy(project string, resource string, globalsetpolicyrequest *GlobalSetPolicyRequest) *DeploymentsSetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy.
- project: Project ID for this request. - resource: Name or id of the resource for this request.
func (r *DeploymentsService) Stop(project string, deployment string, deploymentsstoprequest *DeploymentsStopRequest) *DeploymentsStopCall
Stop: Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
func (r *DeploymentsService) TestIamPermissions(project string, resource string, testpermissionsrequest *TestPermissionsRequest) *DeploymentsTestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the specified resource.
- project: Project ID for this request. - resource: Name or id of the resource for this request.
func (r *DeploymentsService) Update(project string, deployment string, deployment2 *Deployment) *DeploymentsUpdateCall
Update: Updates a deployment and all of the resources described by the deployment manifest.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
type DeploymentsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsSetIamPolicyCall) Context(ctx context.Context) *DeploymentsSetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "deploymentmanager.deployments.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DeploymentsSetIamPolicyCall) Fields(s ...googleapi.Field) *DeploymentsSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DeploymentsSetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DeploymentsStopCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsStopCall) Context(ctx context.Context) *DeploymentsStopCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsStopCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "deploymentmanager.deployments.stop" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DeploymentsStopCall) Fields(s ...googleapi.Field) *DeploymentsStopCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DeploymentsStopCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DeploymentsStopRequest struct {
// Fingerprint: Specifies a fingerprint for `stop()` requests. A fingerprint is
// a randomly generated value that must be provided in `stop()` requests to
// perform optimistic locking. This ensures optimistic concurrency so that the
// deployment does not have conflicting requests (e.g. if someone attempts to
// make a new update request while another user attempts to stop an ongoing
// update request, this would prevent a collision). The fingerprint is
// initially generated by Deployment Manager and changes after every request to
// modify a deployment. To get the latest fingerprint value, perform a `get()`
// request on the deployment.
Fingerprint string `json:"fingerprint,omitempty"`
// ForceSendFields is a list of field names (e.g. "Fingerprint") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeploymentsStopRequest) MarshalJSON() ([]byte, error)
type DeploymentsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsTestIamPermissionsCall) Context(ctx context.Context) *DeploymentsTestIamPermissionsCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestPermissionsResponse, error)
Do executes the "deploymentmanager.deployments.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DeploymentsTestIamPermissionsCall) Fields(s ...googleapi.Field) *DeploymentsTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DeploymentsTestIamPermissionsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DeploymentsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *DeploymentsUpdateCall) Context(ctx context.Context) *DeploymentsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *DeploymentsUpdateCall) CreatePolicy(createPolicy string) *DeploymentsUpdateCall
CreatePolicy sets the optional parameter "createPolicy": Sets the policy to use for creating new resources.
Possible values:
"CREATE_OR_ACQUIRE" (default) "ACQUIRE"
func (c *DeploymentsUpdateCall) DeletePolicy(deletePolicy string) *DeploymentsUpdateCall
DeletePolicy sets the optional parameter "deletePolicy": Sets the policy to use for deleting resources.
Possible values:
"DELETE" (default) "ABANDON"
func (c *DeploymentsUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "deploymentmanager.deployments.update" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DeploymentsUpdateCall) Fields(s ...googleapi.Field) *DeploymentsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DeploymentsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DeploymentsUpdateCall) Preview(preview bool) *DeploymentsUpdateCall
Preview sets the optional parameter "preview": If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
type Expr struct {
// Description: Optional. Description of the expression. This is a longer text
// which describes the expression, e.g. when hovered over it in a UI.
Description string `json:"description,omitempty"`
// Expression: Textual representation of an expression in Common Expression
// Language syntax.
Expression string `json:"expression,omitempty"`
// Location: Optional. String indicating the location of the expression for
// error reporting, e.g. a file name and a position in the file.
Location string `json:"location,omitempty"`
// Title: Optional. Title for the expression, i.e. a short string describing
// its purpose. This can be used e.g. in UIs which allow to enter the
// expression.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Expr) MarshalJSON() ([]byte, error)
type GlobalSetPolicyRequest struct {
// Bindings: Flatten Policy to create a backward compatible wire-format.
// Deprecated. Use 'policy' to specify bindings.
Bindings []*Binding `json:"bindings,omitempty"`
// Etag: Flatten Policy to create a backward compatible wire-format.
// Deprecated. Use 'policy' to specify the etag.
Etag string `json:"etag,omitempty"`
// Policy: REQUIRED: The complete policy to be applied to the 'resource'. The
// size of the policy is limited to a few 10s of KB. An empty policy is in
// general a valid policy but certain services (like Projects) might reject
// them.
Policy *Policy `json:"policy,omitempty"`
// ForceSendFields is a list of field names (e.g. "Bindings") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Bindings") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GlobalSetPolicyRequest) MarshalJSON() ([]byte, error)
type ImportFile struct {
// Content: The contents of the file.
Content string `json:"content,omitempty"`
// Name: The name of the file.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Content") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Content") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ImportFile) MarshalJSON() ([]byte, error)
type InstancesBulkInsertOperationMetadata struct {
// PerLocationStatus: Status information per location (location name is key).
// Example key: zones/us-central1-a
PerLocationStatus map[string]BulkInsertOperationStatus `json:"perLocationStatus,omitempty"`
// ForceSendFields is a list of field names (e.g. "PerLocationStatus") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PerLocationStatus") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *InstancesBulkInsertOperationMetadata) MarshalJSON() ([]byte, error)
type Manifest struct {
// Config: Output only. The YAML configuration for this manifest.
Config *ConfigFile `json:"config,omitempty"`
// ExpandedConfig: Output only. The fully-expanded configuration file,
// including any templates and references.
ExpandedConfig string `json:"expandedConfig,omitempty"`
Id uint64 `json:"id,omitempty,string"`
// Imports: Output only. The imported files for this manifest.
Imports []*ImportFile `json:"imports,omitempty"`
// InsertTime: Output only. Creation timestamp in RFC3339 text format.
InsertTime string `json:"insertTime,omitempty"`
// Layout: Output only. The YAML layout for this manifest.
Layout string `json:"layout,omitempty"`
// ManifestSizeBytes: Output only. The computed size of the fully expanded
// manifest.
ManifestSizeBytes int64 `json:"manifestSizeBytes,omitempty,string"`
// ManifestSizeLimitBytes: Output only. The size limit for expanded manifests
// in the project.
ManifestSizeLimitBytes int64 `json:"manifestSizeLimitBytes,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"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Config") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Manifest) MarshalJSON() ([]byte, error)
type ManifestsGetCall struct {
// contains filtered or unexported fields
}
func (c *ManifestsGetCall) Context(ctx context.Context) *ManifestsGetCall
Context sets the context to be used in this call's Do method.
func (c *ManifestsGetCall) Do(opts ...googleapi.CallOption) (*Manifest, error)
Do executes the "deploymentmanager.manifests.get" call. Any non-2xx status code is an error. Response headers are in either *Manifest.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ManifestsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManifestsGetCall) IfNoneMatch(entityTag string) *ManifestsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ManifestsListCall struct {
// contains filtered or unexported fields
}
func (c *ManifestsListCall) Context(ctx context.Context) *ManifestsListCall
Context sets the context to be used in this call's Do method.
func (c *ManifestsListCall) Do(opts ...googleapi.CallOption) (*ManifestsListResponse, error)
Do executes the "deploymentmanager.manifests.list" call. Any non-2xx status code is an error. Response headers are in either *ManifestsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ManifestsListCall) Filter(filter string) *ManifestsListCall
Filter sets the optional parameter "filter": A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal" `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
func (c *ManifestsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManifestsListCall) IfNoneMatch(entityTag string) *ManifestsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ManifestsListCall) MaxResults(maxResults int64) *ManifestsListCall
MaxResults sets the optional parameter "maxResults": The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
func (c *ManifestsListCall) OrderBy(orderBy string) *ManifestsListCall
OrderBy sets the optional parameter "orderBy": Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc". This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
func (c *ManifestsListCall) PageToken(pageToken string) *ManifestsListCall
PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
func (c *ManifestsListCall) Pages(ctx context.Context, f func(*ManifestsListResponse) 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.
ManifestsListResponse: A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
type ManifestsListResponse struct {
// Manifests: Output only. Manifests contained in this list response.
Manifests []*Manifest `json:"manifests,omitempty"`
// NextPageToken: Output only. A token used to continue a truncated list
// request.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Manifests") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Manifests") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ManifestsListResponse) MarshalJSON() ([]byte, error)
type ManifestsService struct {
// contains filtered or unexported fields
}
func NewManifestsService(s *Service) *ManifestsService
func (r *ManifestsService) Get(project string, deployment string, manifest string) *ManifestsGetCall
Get: Gets information about a specific manifest.
- deployment: The name of the deployment for this request. - manifest: The name of the manifest for this request. - project: The project ID for this request.
func (r *ManifestsService) List(project string, deployment string) *ManifestsListCall
List: Lists all manifests for a given deployment.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
Operation: Represents an Operation resource. Google Compute Engine has three Operation resources: * Global (/compute/docs/reference/rest/{$api_version}/globalOperations) * Regional (/compute/docs/reference/rest/{$api_version}/regionOperations) * Zonal (/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
type Operation struct {
// ClientOperationId: [Output Only] The value of `requestId` if you provided it
// in the request. Not present otherwise.
ClientOperationId string `json:"clientOperationId,omitempty"`
// CreationTimestamp: [Deprecated] This field is deprecated.
CreationTimestamp string `json:"creationTimestamp,omitempty"`
// Description: [Output Only] A textual description of the operation, which is
// set when the operation is created.
Description string `json:"description,omitempty"`
// EndTime: [Output Only] The time that this operation was completed. This
// value is in RFC3339 text format.
EndTime string `json:"endTime,omitempty"`
// Error: [Output Only] If errors are generated during processing of the
// operation, this field will be populated.
Error *OperationError `json:"error,omitempty"`
// HttpErrorMessage: [Output Only] If the operation fails, this field contains
// the HTTP error message that was returned, such as `NOT FOUND`.
HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
// HttpErrorStatusCode: [Output Only] If the operation fails, this field
// contains the HTTP error status code that was returned. For example, a `404`
// means the resource was not found.
HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
// Id: [Output Only] The unique identifier for the operation. This identifier
// is defined by the server.
Id uint64 `json:"id,omitempty,string"`
// InsertTime: [Output Only] The time that this operation was requested. This
// value is in RFC3339 text format.
InsertTime string `json:"insertTime,omitempty"`
InstancesBulkInsertOperationMetadata *InstancesBulkInsertOperationMetadata `json:"instancesBulkInsertOperationMetadata,omitempty"`
// Kind: [Output Only] Type of the resource. Always `compute#operation` for
// Operation resources.
Kind string `json:"kind,omitempty"`
// Name: [Output Only] Name of the operation.
Name string `json:"name,omitempty"`
// OperationGroupId: [Output Only] An ID that represents a group of operations,
// such as when a group of operations results from a `bulkInsert` API request.
OperationGroupId string `json:"operationGroupId,omitempty"`
// OperationType: [Output Only] The type of operation, such as `insert`,
// `update`, or `delete`, and so on.
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 when the operation will be
// complete. This number should monotonically increase as the operation
// progresses.
Progress int64 `json:"progress,omitempty"`
// Region: [Output Only] The URL of the region where the operation resides.
// Only applicable when performing regional operations.
Region string `json:"region,omitempty"`
// SelfLink: [Output Only] Server-defined URL for the resource.
SelfLink string `json:"selfLink,omitempty"`
// SetCommonInstanceMetadataOperationMetadata: [Output Only] If the operation
// is for projects.setCommonInstanceMetadata, this field will contain
// information on all underlying zonal actions and their state.
SetCommonInstanceMetadataOperationMetadata *SetCommonInstanceMetadataOperationMetadata `json:"setCommonInstanceMetadataOperationMetadata,omitempty"`
// StartTime: [Output Only] The time that this operation was started by the
// server. This value is in RFC3339 text format.
StartTime string `json:"startTime,omitempty"`
// Status: [Output Only] The status of the operation, which can be one of the
// following: `PENDING`, `RUNNING`, or `DONE`.
//
// Possible values:
// "PENDING"
// "RUNNING"
// "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] The unique target ID, which identifies a specific
// incarnation of the target resource.
TargetId uint64 `json:"targetId,omitempty,string"`
// TargetLink: [Output Only] The URL of the resource that the operation
// modifies. For operations related to creating a snapshot, this points to the
// persistent disk that the snapshot was created from.
TargetLink string `json:"targetLink,omitempty"`
// User: [Output Only] User who requested the operation, for example:
// `user@example.com` or `alice_smith_identifier
// (global/workforcePools/example-com-us-employees)`.
User string `json:"user,omitempty"`
// Warnings: [Output Only] If warning messages are generated during processing
// of the operation, this field will be populated.
Warnings []*OperationWarnings `json:"warnings,omitempty"`
// Zone: [Output Only] The URL of the zone where the operation resides. Only
// applicable when performing per-zone operations.
Zone string `json:"zone,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ClientOperationId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ClientOperationId") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error)
OperationError: [Output Only] If errors are generated during processing of the operation, this field will be populated.
type OperationError struct {
// Errors: [Output Only] The array of errors encountered while processing this
// operation.
Errors []*OperationErrorErrors `json:"errors,omitempty"`
// ForceSendFields is a list of field names (e.g. "Errors") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Errors") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OperationError) MarshalJSON() ([]byte, error)
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 that 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"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OperationErrorErrors) MarshalJSON() ([]byte, error)
type OperationWarnings struct {
// Code: [Output Only] A warning code, if applicable. For example, Compute
// Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
//
// Possible values:
// "DEPRECATED_RESOURCE_USED" - A link to a deprecated resource was created.
// "NO_RESULTS_ON_PAGE" - No results are present on a particular list page.
// "UNREACHABLE" - A given scope cannot be reached.
// "NEXT_HOP_ADDRESS_NOT_ASSIGNED" - The route's nextHopIp address is not
// assigned to an instance on the network.
// "NEXT_HOP_INSTANCE_NOT_FOUND" - The route's nextHopInstance URL refers to
// an instance that does not exist.
// "NEXT_HOP_INSTANCE_NOT_ON_NETWORK" - The route's nextHopInstance URL
// refers to an instance that is not on the same network as the route.
// "NEXT_HOP_CANNOT_IP_FORWARD" - The route's next hop instance cannot ip
// forward.
// "NEXT_HOP_NOT_RUNNING" - The route's next hop instance does not have a
// status of RUNNING.
// "INJECTED_KERNELS_DEPRECATED" - The operation involved use of an injected
// kernel, which is deprecated.
// "REQUIRED_TOS_AGREEMENT" - The user attempted to use a resource that
// requires a TOS they have not accepted.
// "DISK_SIZE_LARGER_THAN_IMAGE_SIZE" - The user created a boot disk that is
// larger than image size.
// "RESOURCE_NOT_DELETED" - One or more of the resources set to auto-delete
// could not be deleted because they were in use.
// "SINGLE_INSTANCE_PROPERTY_TEMPLATE" - Instance template used in instance
// group manager is valid as such, but its application does not make a lot of
// sense, because it allows only single instance in instance group.
// "NOT_CRITICAL_ERROR" - Error which is not critical. We decided to continue
// the process despite the mentioned error.
// "CLEANUP_FAILED" - Warning about failed cleanup of transient changes made
// by a failed operation.
// "FIELD_VALUE_OVERRIDEN" - Warning that value of a field has been
// overridden. Deprecated unused field.
// "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING" - Warning that a resource is
// in use.
// "MISSING_TYPE_DEPENDENCY" - A resource depends on a missing type
// "EXTERNAL_API_WARNING" - Warning that is present in an external api call
// "SCHEMA_VALIDATION_IGNORED" - When a resource schema validation is
// ignored.
// "UNDECLARED_PROPERTIES" - When undeclared properties in the schema are
// present
// "EXPERIMENTAL_TYPE_USED" - When deploying and at least one of the
// resources has a type marked as experimental
// "DEPRECATED_TYPE_USED" - When deploying and at least one of the resources
// has a type marked as deprecated
// "PARTIAL_SUCCESS" - Success is reported, but some results may be missing
// due to errors
// "LARGE_DEPLOYMENT_WARNING" - When deploying a deployment with a
// exceedingly large number of resources
// "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" - The route's nextHopInstance
// URL refers to an instance that does not have an ipv6 interface on the same
// network as the route.
// "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" - A WEIGHTED_MAGLEV backend
// service is associated with a health check that is not of type
// HTTP/HTTPS/HTTP2.
// "LIST_OVERHEAD_QUOTA_EXCEED" - Resource can't be retrieved due to list
// overhead quota exceed which captures the amount of resources filtered out by
// user-defined list filter.
Code string `json:"code,omitempty"`
// Data: [Output Only] Metadata about this warning in key: value format. For
// example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Data []*OperationWarningsData `json:"data,omitempty"`
// Message: [Output Only] A human-readable description of the warning code.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OperationWarnings) MarshalJSON() ([]byte, error)
type OperationWarningsData struct {
// Key: [Output Only] A key that provides more detail on the warning being
// returned. For example, for warnings where there are no results in a list
// request for a particular zone, this key might be scope and the key value
// might be the zone name. Other examples might be a key indicating a
// deprecated resource and a suggested replacement, or a warning about invalid
// network settings (for example, if an instance attempts to perform IP
// forwarding but is not enabled for IP forwarding).
Key string `json:"key,omitempty"`
// Value: [Output Only] A warning data value corresponding to the key.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OperationWarningsData) MarshalJSON() ([]byte, error)
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "deploymentmanager.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *OperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
Context sets the context to be used in this call's Do method.
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*OperationsListResponse, error)
Do executes the "deploymentmanager.operations.list" call. Any non-2xx status code is an error. Response headers are in either *OperationsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal" `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
func (c *OperationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall
MaxResults sets the optional parameter "maxResults": The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
func (c *OperationsListCall) OrderBy(orderBy string) *OperationsListCall
OrderBy sets the optional parameter "orderBy": Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc". This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
func (c *OperationsListCall) Pages(ctx context.Context, f func(*OperationsListResponse) 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.
OperationsListResponse: A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
type OperationsListResponse struct {
// NextPageToken: Output only. A token used to continue a truncated list
// request.
NextPageToken string `json:"nextPageToken,omitempty"`
// Operations: Output only. Operations contained in this list response.
Operations []*Operation `json:"operations,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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OperationsListResponse) MarshalJSON() ([]byte, error)
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService(s *Service) *OperationsService
func (r *OperationsService) Get(project string, operation string) *OperationsGetCall
Get: Gets information about a specific operation.
- operation: The name of the operation for this request. - project: The project ID for this request.
func (r *OperationsService) List(project string) *OperationsListCall
List: Lists all operations for a project.
- project: The project ID for this request.
Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
type Policy struct {
// AuditConfigs: Specifies cloud audit logging configuration for this policy.
AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
// Bindings: Associates a list of `members`, or principals, with a `role`.
// Optionally, may specify a `condition` that determines how and when the
// `bindings` are applied. Each of the `bindings` must contain at least one
// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
// up to 250 of these principals can be Google groups. Each occurrence of a
// principal counts towards these limits. For example, if the `bindings` grant
// 50 different roles to `user:alice@example.com`, and not to any other
// principal, then you can add another 1,450 principals to the `bindings` in
// the `Policy`.
Bindings []*Binding `json:"bindings,omitempty"`
// Etag: `etag` is used for optimistic concurrency control as a way to help
// prevent simultaneous updates of a policy from overwriting each other. It is
// strongly suggested that systems make use of the `etag` in the
// read-modify-write cycle to perform policy updates in order to avoid race
// conditions: An `etag` is returned in the response to `getIamPolicy`, and
// systems are expected to put that etag in the request to `setIamPolicy` to
// ensure that their change will be applied to the same version of the policy.
// **Important:** If you use IAM Conditions, you must include the `etag` field
// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
// you to overwrite a version `3` policy with a version `1` policy, and all of
// the conditions in the version `3` policy are lost.
Etag string `json:"etag,omitempty"`
// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
// `3`. Requests that specify an invalid value are rejected. Any operation that
// affects conditional role bindings must specify version `3`. This requirement
// applies to the following operations: * Getting a policy that includes a
// conditional role binding * Adding a conditional role binding to a policy *
// Changing a conditional role binding in a policy * Removing any role binding,
// with or without a condition, from a policy that includes conditions
// **Important:** If you use IAM Conditions, you must include the `etag` field
// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
// you to overwrite a version `3` policy with a version `1` policy, and all of
// the conditions in the version `3` policy are lost. If a policy does not
// include any conditions, operations on that policy may specify any valid
// version or leave the field unset. To learn which resources support
// conditions in their IAM policies, see the IAM documentation
// (https://cloud.google.com/iam/help/conditions/resource-policies).
Version int64 `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AuditConfigs") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AuditConfigs") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Policy) MarshalJSON() ([]byte, error)
type Resource struct {
// AccessControl: The Access Control Policy set on this resource.
AccessControl *ResourceAccessControl `json:"accessControl,omitempty"`
// FinalProperties: Output only. The evaluated properties of the resource with
// references expanded. Returned as serialized YAML.
FinalProperties string `json:"finalProperties,omitempty"`
Id uint64 `json:"id,omitempty,string"`
// InsertTime: Output only. Creation timestamp in RFC3339 text format.
InsertTime string `json:"insertTime,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"`
// Properties: Output only. The current properties of the resource before any
// references have been filled in. Returned as serialized YAML.
Properties string `json:"properties,omitempty"`
// Type: Output only. The type of the resource, for example
// `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
Type string `json:"type,omitempty"`
// Update: Output only. If Deployment Manager is currently updating or
// previewing an update to this resource, the updated configuration appears
// here.
Update *ResourceUpdate `json:"update,omitempty"`
// UpdateTime: Output only. Update timestamp in RFC3339 text format.
UpdateTime string `json:"updateTime,omitempty"`
// Url: Output only. The URL of the actual resource.
Url string `json:"url,omitempty"`
// Warnings: Output only. If warning messages are generated during processing
// of this resource, this field will be populated.
Warnings []*ResourceWarnings `json:"warnings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AccessControl") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccessControl") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Resource) MarshalJSON() ([]byte, error)
ResourceAccessControl: The access controls set on the resource.
type ResourceAccessControl struct {
// GcpIamPolicy: The GCP IAM Policy to set on the resource.
GcpIamPolicy string `json:"gcpIamPolicy,omitempty"`
// ForceSendFields is a list of field names (e.g. "GcpIamPolicy") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GcpIamPolicy") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceAccessControl) MarshalJSON() ([]byte, error)
type ResourceUpdate struct {
// AccessControl: The Access Control Policy to set on this resource after
// updating the resource itself.
AccessControl *ResourceAccessControl `json:"accessControl,omitempty"`
// Error: Output only. If errors are generated during update of the resource,
// this field will be populated.
Error *ResourceUpdateError `json:"error,omitempty"`
// FinalProperties: Output only. The expanded properties of the resource with
// reference values expanded. Returned as serialized YAML.
FinalProperties string `json:"finalProperties,omitempty"`
// Intent: Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or
// `CANCEL`.
//
// Possible values:
// "CREATE_OR_ACQUIRE" - The resource is scheduled to be created, or if it
// already exists, acquired.
// "DELETE" - The resource is scheduled to be deleted.
// "ACQUIRE" - The resource is scheduled to be acquired.
// "UPDATE" - The resource is scheduled to be updated via the UPDATE method.
// "ABANDON" - The resource is scheduled to be abandoned.
// "CREATE" - The resource is scheduled to be created.
Intent string `json:"intent,omitempty"`
// Manifest: Output only. URL of the manifest representing the update
// configuration of this resource.
Manifest string `json:"manifest,omitempty"`
// Properties: Output only. The set of updated properties for this resource,
// before references are expanded. Returned as serialized YAML.
Properties string `json:"properties,omitempty"`
// State: Output only. The state of the resource.
//
// Possible values:
// "PENDING" - There are changes pending for this resource.
// "IN_PROGRESS" - The service is executing changes on the resource.
// "IN_PREVIEW" - The service is previewing changes on the resource.
// "FAILED" - The service has failed to change the resource.
// "ABORTED" - The service has aborted trying to change the resource.
State string `json:"state,omitempty"`
// Warnings: Output only. If warning messages are generated during processing
// of this resource, this field will be populated.
Warnings []*ResourceUpdateWarnings `json:"warnings,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccessControl") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccessControl") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceUpdate) MarshalJSON() ([]byte, error)
ResourceUpdateError: Output only. If errors are generated during update of the resource, this field will be populated.
type ResourceUpdateError struct {
// Errors: [Output Only] The array of errors encountered while processing this
// operation.
Errors []*ResourceUpdateErrorErrors `json:"errors,omitempty"`
// ForceSendFields is a list of field names (e.g. "Errors") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Errors") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceUpdateError) MarshalJSON() ([]byte, error)
type ResourceUpdateErrorErrors 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 that 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"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceUpdateErrorErrors) MarshalJSON() ([]byte, error)
type ResourceUpdateWarnings struct {
// Code: [Output Only] A warning code, if applicable. For example, Compute
// Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
//
// Possible values:
// "DEPRECATED_RESOURCE_USED" - A link to a deprecated resource was created.
// "NO_RESULTS_ON_PAGE" - No results are present on a particular list page.
// "UNREACHABLE" - A given scope cannot be reached.
// "NEXT_HOP_ADDRESS_NOT_ASSIGNED" - The route's nextHopIp address is not
// assigned to an instance on the network.
// "NEXT_HOP_INSTANCE_NOT_FOUND" - The route's nextHopInstance URL refers to
// an instance that does not exist.
// "NEXT_HOP_INSTANCE_NOT_ON_NETWORK" - The route's nextHopInstance URL
// refers to an instance that is not on the same network as the route.
// "NEXT_HOP_CANNOT_IP_FORWARD" - The route's next hop instance cannot ip
// forward.
// "NEXT_HOP_NOT_RUNNING" - The route's next hop instance does not have a
// status of RUNNING.
// "INJECTED_KERNELS_DEPRECATED" - The operation involved use of an injected
// kernel, which is deprecated.
// "REQUIRED_TOS_AGREEMENT" - The user attempted to use a resource that
// requires a TOS they have not accepted.
// "DISK_SIZE_LARGER_THAN_IMAGE_SIZE" - The user created a boot disk that is
// larger than image size.
// "RESOURCE_NOT_DELETED" - One or more of the resources set to auto-delete
// could not be deleted because they were in use.
// "SINGLE_INSTANCE_PROPERTY_TEMPLATE" - Instance template used in instance
// group manager is valid as such, but its application does not make a lot of
// sense, because it allows only single instance in instance group.
// "NOT_CRITICAL_ERROR" - Error which is not critical. We decided to continue
// the process despite the mentioned error.
// "CLEANUP_FAILED" - Warning about failed cleanup of transient changes made
// by a failed operation.
// "FIELD_VALUE_OVERRIDEN" - Warning that value of a field has been
// overridden. Deprecated unused field.
// "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING" - Warning that a resource is
// in use.
// "MISSING_TYPE_DEPENDENCY" - A resource depends on a missing type
// "EXTERNAL_API_WARNING" - Warning that is present in an external api call
// "SCHEMA_VALIDATION_IGNORED" - When a resource schema validation is
// ignored.
// "UNDECLARED_PROPERTIES" - When undeclared properties in the schema are
// present
// "EXPERIMENTAL_TYPE_USED" - When deploying and at least one of the
// resources has a type marked as experimental
// "DEPRECATED_TYPE_USED" - When deploying and at least one of the resources
// has a type marked as deprecated
// "PARTIAL_SUCCESS" - Success is reported, but some results may be missing
// due to errors
// "LARGE_DEPLOYMENT_WARNING" - When deploying a deployment with a
// exceedingly large number of resources
// "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" - The route's nextHopInstance
// URL refers to an instance that does not have an ipv6 interface on the same
// network as the route.
// "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" - A WEIGHTED_MAGLEV backend
// service is associated with a health check that is not of type
// HTTP/HTTPS/HTTP2.
// "LIST_OVERHEAD_QUOTA_EXCEED" - Resource can't be retrieved due to list
// overhead quota exceed which captures the amount of resources filtered out by
// user-defined list filter.
Code string `json:"code,omitempty"`
// Data: [Output Only] Metadata about this warning in key: value format. For
// example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Data []*ResourceUpdateWarningsData `json:"data,omitempty"`
// Message: [Output Only] A human-readable description of the warning code.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceUpdateWarnings) MarshalJSON() ([]byte, error)
type ResourceUpdateWarningsData struct {
// Key: [Output Only] A key that provides more detail on the warning being
// returned. For example, for warnings where there are no results in a list
// request for a particular zone, this key might be scope and the key value
// might be the zone name. Other examples might be a key indicating a
// deprecated resource and a suggested replacement, or a warning about invalid
// network settings (for example, if an instance attempts to perform IP
// forwarding but is not enabled for IP forwarding).
Key string `json:"key,omitempty"`
// Value: [Output Only] A warning data value corresponding to the key.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceUpdateWarningsData) MarshalJSON() ([]byte, error)
type ResourceWarnings struct {
// Code: [Output Only] A warning code, if applicable. For example, Compute
// Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
//
// Possible values:
// "DEPRECATED_RESOURCE_USED" - A link to a deprecated resource was created.
// "NO_RESULTS_ON_PAGE" - No results are present on a particular list page.
// "UNREACHABLE" - A given scope cannot be reached.
// "NEXT_HOP_ADDRESS_NOT_ASSIGNED" - The route's nextHopIp address is not
// assigned to an instance on the network.
// "NEXT_HOP_INSTANCE_NOT_FOUND" - The route's nextHopInstance URL refers to
// an instance that does not exist.
// "NEXT_HOP_INSTANCE_NOT_ON_NETWORK" - The route's nextHopInstance URL
// refers to an instance that is not on the same network as the route.
// "NEXT_HOP_CANNOT_IP_FORWARD" - The route's next hop instance cannot ip
// forward.
// "NEXT_HOP_NOT_RUNNING" - The route's next hop instance does not have a
// status of RUNNING.
// "INJECTED_KERNELS_DEPRECATED" - The operation involved use of an injected
// kernel, which is deprecated.
// "REQUIRED_TOS_AGREEMENT" - The user attempted to use a resource that
// requires a TOS they have not accepted.
// "DISK_SIZE_LARGER_THAN_IMAGE_SIZE" - The user created a boot disk that is
// larger than image size.
// "RESOURCE_NOT_DELETED" - One or more of the resources set to auto-delete
// could not be deleted because they were in use.
// "SINGLE_INSTANCE_PROPERTY_TEMPLATE" - Instance template used in instance
// group manager is valid as such, but its application does not make a lot of
// sense, because it allows only single instance in instance group.
// "NOT_CRITICAL_ERROR" - Error which is not critical. We decided to continue
// the process despite the mentioned error.
// "CLEANUP_FAILED" - Warning about failed cleanup of transient changes made
// by a failed operation.
// "FIELD_VALUE_OVERRIDEN" - Warning that value of a field has been
// overridden. Deprecated unused field.
// "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING" - Warning that a resource is
// in use.
// "MISSING_TYPE_DEPENDENCY" - A resource depends on a missing type
// "EXTERNAL_API_WARNING" - Warning that is present in an external api call
// "SCHEMA_VALIDATION_IGNORED" - When a resource schema validation is
// ignored.
// "UNDECLARED_PROPERTIES" - When undeclared properties in the schema are
// present
// "EXPERIMENTAL_TYPE_USED" - When deploying and at least one of the
// resources has a type marked as experimental
// "DEPRECATED_TYPE_USED" - When deploying and at least one of the resources
// has a type marked as deprecated
// "PARTIAL_SUCCESS" - Success is reported, but some results may be missing
// due to errors
// "LARGE_DEPLOYMENT_WARNING" - When deploying a deployment with a
// exceedingly large number of resources
// "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" - The route's nextHopInstance
// URL refers to an instance that does not have an ipv6 interface on the same
// network as the route.
// "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" - A WEIGHTED_MAGLEV backend
// service is associated with a health check that is not of type
// HTTP/HTTPS/HTTP2.
// "LIST_OVERHEAD_QUOTA_EXCEED" - Resource can't be retrieved due to list
// overhead quota exceed which captures the amount of resources filtered out by
// user-defined list filter.
Code string `json:"code,omitempty"`
// Data: [Output Only] Metadata about this warning in key: value format. For
// example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Data []*ResourceWarningsData `json:"data,omitempty"`
// Message: [Output Only] A human-readable description of the warning code.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceWarnings) MarshalJSON() ([]byte, error)
type ResourceWarningsData struct {
// Key: [Output Only] A key that provides more detail on the warning being
// returned. For example, for warnings where there are no results in a list
// request for a particular zone, this key might be scope and the key value
// might be the zone name. Other examples might be a key indicating a
// deprecated resource and a suggested replacement, or a warning about invalid
// network settings (for example, if an instance attempts to perform IP
// forwarding but is not enabled for IP forwarding).
Key string `json:"key,omitempty"`
// Value: [Output Only] A warning data value corresponding to the key.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourceWarningsData) MarshalJSON() ([]byte, error)
type ResourcesGetCall struct {
// contains filtered or unexported fields
}
func (c *ResourcesGetCall) Context(ctx context.Context) *ResourcesGetCall
Context sets the context to be used in this call's Do method.
func (c *ResourcesGetCall) Do(opts ...googleapi.CallOption) (*Resource, error)
Do executes the "deploymentmanager.resources.get" call. Any non-2xx status code is an error. Response headers are in either *Resource.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ResourcesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ResourcesGetCall) IfNoneMatch(entityTag string) *ResourcesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ResourcesListCall struct {
// contains filtered or unexported fields
}
func (c *ResourcesListCall) Context(ctx context.Context) *ResourcesListCall
Context sets the context to be used in this call's Do method.
func (c *ResourcesListCall) Do(opts ...googleapi.CallOption) (*ResourcesListResponse, error)
Do executes the "deploymentmanager.resources.list" call. Any non-2xx status code is an error. Response headers are in either *ResourcesListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ResourcesListCall) Filter(filter string) *ResourcesListCall
Filter sets the optional parameter "filter": A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal" `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
func (c *ResourcesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ResourcesListCall) IfNoneMatch(entityTag string) *ResourcesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ResourcesListCall) MaxResults(maxResults int64) *ResourcesListCall
MaxResults sets the optional parameter "maxResults": The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
func (c *ResourcesListCall) OrderBy(orderBy string) *ResourcesListCall
OrderBy sets the optional parameter "orderBy": Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc". This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
func (c *ResourcesListCall) PageToken(pageToken string) *ResourcesListCall
PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
func (c *ResourcesListCall) Pages(ctx context.Context, f func(*ResourcesListResponse) 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.
ResourcesListResponse: A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
type ResourcesListResponse struct {
// NextPageToken: A token used to continue a truncated list request.
NextPageToken string `json:"nextPageToken,omitempty"`
// Resources: Resources contained in this list response.
Resources []*Resource `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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResourcesListResponse) MarshalJSON() ([]byte, error)
type ResourcesService struct {
// contains filtered or unexported fields
}
func NewResourcesService(s *Service) *ResourcesService
func (r *ResourcesService) Get(project string, deployment string, resource string) *ResourcesGetCall
Get: Gets information about a single resource.
- deployment: The name of the deployment for this request. - project: The project ID for this request. - resource: The name of the resource for this request.
func (r *ResourcesService) List(project string, deployment string) *ResourcesListCall
List: Lists all resources in a given deployment.
- deployment: The name of the deployment for this request. - project: The project ID for this request.
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
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
type SetCommonInstanceMetadataOperationMetadata struct {
// ClientOperationId: [Output Only] The client operation id.
ClientOperationId string `json:"clientOperationId,omitempty"`
// PerLocationOperations: [Output Only] Status information per location
// (location name is key). Example key: zones/us-central1-a
PerLocationOperations map[string]SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo `json:"perLocationOperations,omitempty"`
// ForceSendFields is a list of field names (e.g. "ClientOperationId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ClientOperationId") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SetCommonInstanceMetadataOperationMetadata) MarshalJSON() ([]byte, error)
type SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo struct {
// Error: [Output Only] If state is `ABANDONED` or `FAILED`, this field is
// populated.
Error *Status `json:"error,omitempty"`
// State: [Output Only] Status of the action, which can be one of the
// following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
//
// Possible values:
// "UNSPECIFIED"
// "PROPAGATING" - Operation is not yet confirmed to have been created in the
// location.
// "PROPAGATED" - Operation is confirmed to be in the location.
// "ABANDONED" - Operation not tracked in this location e.g. zone is marked
// as DOWN.
// "FAILED" - Operation is in an error state.
// "DONE" - Operation has completed successfully.
State string `json:"state,omitempty"`
// ForceSendFields is a list of field names (e.g. "Error") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Error") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo) MarshalJSON() ([]byte, error)
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
type Status struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: A developer-facing error message, which should be in English. Any
// user-facing error message should be localized and sent in the
// google.rpc.Status.details field, or localized by the client.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
type TargetConfiguration struct {
// Config: The configuration to use for this deployment.
Config *ConfigFile `json:"config,omitempty"`
// Imports: Specifies any files to import for this configuration. This can be
// used to import templates or other files. For example, you might import a
// text file in order to use the file in a template.
Imports []*ImportFile `json:"imports,omitempty"`
// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Config") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TargetConfiguration) MarshalJSON() ([]byte, error)
type TestPermissionsRequest struct {
// Permissions: The set of permissions to check for the 'resource'. Permissions
// with wildcards (such as '*' or 'storage.*') are not allowed.
Permissions []string `json:"permissions,omitempty"`
// ForceSendFields is a list of field names (e.g. "Permissions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Permissions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TestPermissionsRequest) MarshalJSON() ([]byte, error)
type TestPermissionsResponse struct {
// Permissions: A subset of `TestPermissionsRequest.permissions` that the
// caller is allowed.
Permissions []string `json:"permissions,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Permissions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Permissions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TestPermissionsResponse) MarshalJSON() ([]byte, error)
Type: A resource type supported by Deployment Manager.
type Type struct {
Id uint64 `json:"id,omitempty,string"`
// InsertTime: Output only. Creation timestamp in RFC3339 text format.
InsertTime string `json:"insertTime,omitempty"`
// Name: Name of the type.
Name string `json:"name,omitempty"`
// Operation: Output only. The Operation that most recently ran, or is
// currently running, on this type.
Operation *Operation `json:"operation,omitempty"`
// SelfLink: Output only. Server defined URL for the resource.
SelfLink string `json:"selfLink,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Id") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Type) MarshalJSON() ([]byte, error)
type TypesListCall struct {
// contains filtered or unexported fields
}
func (c *TypesListCall) Context(ctx context.Context) *TypesListCall
Context sets the context to be used in this call's Do method.
func (c *TypesListCall) Do(opts ...googleapi.CallOption) (*TypesListResponse, error)
Do executes the "deploymentmanager.types.list" call. Any non-2xx status code is an error. Response headers are in either *TypesListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *TypesListCall) Filter(filter string) *TypesListCall
Filter sets the optional parameter "filter": A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal" `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
func (c *TypesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *TypesListCall) IfNoneMatch(entityTag string) *TypesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *TypesListCall) MaxResults(maxResults int64) *TypesListCall
MaxResults sets the optional parameter "maxResults": The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
func (c *TypesListCall) OrderBy(orderBy string) *TypesListCall
OrderBy sets the optional parameter "orderBy": Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc". This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
func (c *TypesListCall) PageToken(pageToken string) *TypesListCall
PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
func (c *TypesListCall) Pages(ctx context.Context, f func(*TypesListResponse) 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.
TypesListResponse: A response that returns all Types supported by Deployment Manager
type TypesListResponse struct {
// NextPageToken: A token used to continue a truncated list request.
NextPageToken string `json:"nextPageToken,omitempty"`
// Types: Output only. A list of resource types supported by Deployment
// Manager.
Types []*Type `json:"types,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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TypesListResponse) MarshalJSON() ([]byte, error)
type TypesService struct {
// contains filtered or unexported fields
}
func NewTypesService(s *Service) *TypesService
func (r *TypesService) List(project string) *TypesListCall
List: Lists all resource types for Deployment Manager.
- project: The project ID for this request.