composer

package
v0.207.0 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2024 License: BSD-3-Clause Imports: 16 Imported by: 32

Documentation

Overview

Package composer provides access to the Cloud Composer API.

For product documentation, see: https://cloud.google.com/composer/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/composer/v1"
...
ctx := context.Background()
composerService, err := composer.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

composerService, err := composer.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
composerService, err := composer.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
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"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AirflowMetadataRetentionPolicyConfig added in v0.168.0 

type AirflowMetadataRetentionPolicyConfig struct {
	// RetentionDays: Optional. How many days data should be retained for.
	RetentionDays int64 `json:"retentionDays,omitempty"`
	// RetentionMode: Optional. Retention can be either enabled or disabled.
	//
	// Possible values:
	//   "RETENTION_MODE_UNSPECIFIED" - Default mode doesn't change environment
	// parameters.
	//   "RETENTION_MODE_ENABLED" - Retention policy is enabled.
	//   "RETENTION_MODE_DISABLED" - Retention policy is disabled.
	RetentionMode string `json:"retentionMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RetentionDays") 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. "RetentionDays") 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:"-"`
}

AirflowMetadataRetentionPolicyConfig: The policy for airflow metadata database retention.

func (AirflowMetadataRetentionPolicyConfig) MarshalJSON added in v0.168.0 

func (s AirflowMetadataRetentionPolicyConfig) MarshalJSON() ([]byte, error)

type AllowedIpRange added in v0.37.0 

type AllowedIpRange struct {
	// Description: Optional. User-provided description. It must contain at most
	// 300 characters.
	Description string `json:"description,omitempty"`
	// Value: IP address or range, defined using CIDR notation, of requests that
	// this rule applies to. Examples: `192.168.1.1` or `192.168.0.0/16` or
	// `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. IP range
	// prefixes should be properly truncated. For example, `1.2.3.4/24` should be
	// truncated to `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` should be
	// truncated to `2001:db8::/32`.
	Value string `json:"value,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:"-"`
}

AllowedIpRange: Allowed IP range with user-provided description.

func (AllowedIpRange) MarshalJSON added in v0.37.0 

func (s AllowedIpRange) MarshalJSON() ([]byte, error)

type CheckUpgradeRequest added in v0.182.0 

type CheckUpgradeRequest struct {
	// ImageVersion: Optional. The version of the software running in the
	// environment. This encapsulates both the version of Cloud Composer
	// functionality and the version of Apache Airflow. It must match the regular
	// expression
	// `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9
	// ]+(\.[0-9]+(\.[0-9]+)?)?)`. When used as input, the server also checks if
	// the provided version is supported and denies the request for an unsupported
	// version. The Cloud Composer portion of the image version is a full semantic
	// version (https://semver.org), or an alias in the form of major version
	// number or `latest`. When an alias is provided, the server replaces it with
	// the current Cloud Composer version that satisfies the alias. The Apache
	// Airflow portion of the image version is a full semantic version that points
	// to one of the supported Apache Airflow versions, or an alias in the form of
	// only major or major.minor versions specified. When an alias is provided, the
	// server replaces it with the latest Apache Airflow version that satisfies the
	// alias and is supported in the given Cloud Composer version. In all cases,
	// the resolved image version is stored in the same field. See also version
	// list (/composer/docs/concepts/versioning/composer-versions) and versioning
	// overview (/composer/docs/concepts/versioning/composer-versioning-overview).
	ImageVersion string `json:"imageVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ImageVersion") 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. "ImageVersion") 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:"-"`
}

CheckUpgradeRequest: Request to check whether image upgrade will succeed.

func (CheckUpgradeRequest) MarshalJSON added in v0.182.0 

func (s CheckUpgradeRequest) MarshalJSON() ([]byte, error)

type CheckUpgradeResponse added in v0.48.0 

type CheckUpgradeResponse struct {
	// BuildLogUri: Output only. Url for a docker build log of an upgraded image.
	BuildLogUri string `json:"buildLogUri,omitempty"`
	// ContainsPypiModulesConflict: Output only. Whether build has succeeded or
	// failed on modules conflicts.
	//
	// Possible values:
	//   "CONFLICT_RESULT_UNSPECIFIED" - It is unknown whether build had conflicts
	// or not.
	//   "CONFLICT" - There were python packages conflicts.
	//   "NO_CONFLICT" - There were no python packages conflicts.
	ContainsPypiModulesConflict string `json:"containsPypiModulesConflict,omitempty"`
	// ImageVersion: Composer image for which the build was happening.
	ImageVersion string `json:"imageVersion,omitempty"`
	// PypiConflictBuildLogExtract: Output only. Extract from a docker image build
	// log containing information about pypi modules conflicts.
	PypiConflictBuildLogExtract string `json:"pypiConflictBuildLogExtract,omitempty"`
	// PypiDependencies: Pypi dependencies specified in the environment
	// configuration, at the time when the build was triggered.
	PypiDependencies map[string]string `json:"pypiDependencies,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BuildLogUri") 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. "BuildLogUri") 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:"-"`
}

CheckUpgradeResponse: Message containing information about the result of an upgrade check operation.

func (CheckUpgradeResponse) MarshalJSON added in v0.48.0 

func (s CheckUpgradeResponse) MarshalJSON() ([]byte, error)

type CidrBlock added in v0.80.0 

type CidrBlock struct {
	// CidrBlock: CIDR block that must be specified in CIDR notation.
	CidrBlock string `json:"cidrBlock,omitempty"`
	// DisplayName: User-defined name that identifies the CIDR block.
	DisplayName string `json:"displayName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CidrBlock") 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. "CidrBlock") 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:"-"`
}

CidrBlock: CIDR block with an optional name.

func (CidrBlock) MarshalJSON added in v0.80.0 

func (s CidrBlock) MarshalJSON() ([]byte, error)

type CloudDataLineageIntegration added in v0.156.0 

type CloudDataLineageIntegration struct {
	// Enabled: Optional. Whether or not Cloud Data Lineage integration is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`
}

CloudDataLineageIntegration: Configuration for Cloud Data Lineage integration.

func (CloudDataLineageIntegration) MarshalJSON added in v0.156.0 

func (s CloudDataLineageIntegration) MarshalJSON() ([]byte, error)

type ComposerWorkload added in v0.160.0 

type ComposerWorkload struct {
	// Name: Name of a workload.
	Name string `json:"name,omitempty"`
	// Status: Output only. Status of a workload.
	Status *ComposerWorkloadStatus `json:"status,omitempty"`
	// Type: Type of a workload.
	//
	// Possible values:
	//   "COMPOSER_WORKLOAD_TYPE_UNSPECIFIED" - Not able to determine the type of
	// the workload.
	//   "CELERY_WORKER" - Celery worker.
	//   "KUBERNETES_WORKER" - Kubernetes worker.
	//   "KUBERNETES_OPERATOR_POD" - Workload created by Kubernetes Pod Operator.
	//   "SCHEDULER" - Airflow scheduler.
	//   "DAG_PROCESSOR" - Airflow Dag processor.
	//   "TRIGGERER" - Airflow triggerer.
	//   "WEB_SERVER" - Airflow web server UI.
	//   "REDIS" - Redis.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty 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. "Name") 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:"-"`
}

ComposerWorkload: Information about a single workload.

func (ComposerWorkload) MarshalJSON added in v0.160.0 

func (s ComposerWorkload) MarshalJSON() ([]byte, error)

type ComposerWorkloadStatus added in v0.160.0 

type ComposerWorkloadStatus struct {
	// DetailedStatusMessage: Output only. Detailed message of the status.
	DetailedStatusMessage string `json:"detailedStatusMessage,omitempty"`
	// State: Output only. Workload state.
	//
	// Possible values:
	//   "COMPOSER_WORKLOAD_STATE_UNSPECIFIED" - Not able to determine the status
	// of the workload.
	//   "PENDING" - Workload is in pending state and has not yet started.
	//   "OK" - Workload is running fine.
	//   "WARNING" - Workload is running but there are some non-critical problems.
	//   "ERROR" - Workload is not running due to an error.
	//   "SUCCEEDED" - Workload has finished execution with success.
	//   "FAILED" - Workload has finished execution with failure.
	State string `json:"state,omitempty"`
	// StatusMessage: Output only. Text to provide more descriptive status.
	StatusMessage string `json:"statusMessage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DetailedStatusMessage") 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. "DetailedStatusMessage") 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:"-"`
}

ComposerWorkloadStatus: Workload status.

func (ComposerWorkloadStatus) MarshalJSON added in v0.160.0 

func (s ComposerWorkloadStatus) MarshalJSON() ([]byte, error)

type DagProcessorResource added in v0.160.0 

type DagProcessorResource struct {
	// Count: Optional. The number of DAG processors. If not provided or set to 0,
	// a single DAG processor instance will be created.
	Count int64 `json:"count,omitempty"`
	// Cpu: Optional. CPU request and limit for a single Airflow DAG processor
	// replica.
	Cpu float64 `json:"cpu,omitempty"`
	// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow DAG
	// processor replica.
	MemoryGb float64 `json:"memoryGb,omitempty"`
	// StorageGb: Optional. Storage (GB) request and limit for a single Airflow DAG
	// processor replica.
	StorageGb float64 `json:"storageGb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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:"-"`
}

DagProcessorResource: Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

func (DagProcessorResource) MarshalJSON added in v0.160.0 

func (s DagProcessorResource) MarshalJSON() ([]byte, error)

func (*DagProcessorResource) UnmarshalJSON added in v0.160.0 

func (s *DagProcessorResource) UnmarshalJSON(data []byte) error

type DataRetentionConfig added in v0.156.0 

type DataRetentionConfig struct {
	// AirflowMetadataRetentionConfig: Optional. The retention policy for airflow
	// metadata database.
	AirflowMetadataRetentionConfig *AirflowMetadataRetentionPolicyConfig `json:"airflowMetadataRetentionConfig,omitempty"`
	// TaskLogsRetentionConfig: Optional. The configuration settings for task logs
	// retention
	TaskLogsRetentionConfig *TaskLogsRetentionConfig `json:"taskLogsRetentionConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "AirflowMetadataRetentionConfig") 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. "AirflowMetadataRetentionConfig")
	// 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:"-"`
}

DataRetentionConfig: The configuration setting for Airflow database data retention mechanism.

func (DataRetentionConfig) MarshalJSON added in v0.156.0 

func (s DataRetentionConfig) MarshalJSON() ([]byte, error)

type DatabaseConfig added in v0.37.0 

type DatabaseConfig struct {
	// MachineType: Optional. Cloud SQL machine type used by Airflow database. It
	// has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or
	// db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
	// Supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*.
	MachineType string `json:"machineType,omitempty"`
	// Zone: Optional. The Compute Engine zone where the Airflow database is
	// created. If zone is provided, it must be in the region selected for the
	// environment. If zone is not provided, a zone is automatically selected. The
	// zone can only be set during environment creation. Supported for Cloud
	// Composer environments in versions composer-2.*.*-airflow-*.*.*.
	Zone string `json:"zone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MachineType") 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. "MachineType") 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:"-"`
}

DatabaseConfig: The configuration of Cloud SQL instance that is used by the Apache Airflow software.

func (DatabaseConfig) MarshalJSON added in v0.37.0 

func (s DatabaseConfig) MarshalJSON() ([]byte, error)

type DatabaseFailoverRequest added in v0.125.0 

type DatabaseFailoverRequest struct {
}

DatabaseFailoverRequest: Request to trigger database failover (only for highly resilient environments).

type DatabaseFailoverResponse added in v0.125.0 

type DatabaseFailoverResponse struct {
}

DatabaseFailoverResponse: Response for DatabaseFailoverRequest.

type Date added in v0.37.0 

type Date struct {
	// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,
	// or 0 to specify a year by itself or a year and month where the day isn't
	// significant.
	Day int64 `json:"day,omitempty"`
	// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without
	// a month and day.
	Month int64 `json:"month,omitempty"`
	// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
	// without a year.
	Year int64 `json:"year,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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:"-"`
}

Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

func (Date) MarshalJSON added in v0.37.0 

func (s Date) MarshalJSON() ([]byte, error)

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EncryptionConfig added in v0.39.0 

type EncryptionConfig struct {
	// KmsKeyName: Optional. Customer-managed Encryption Key available through
	// Google's Key Management Service. Cannot be updated. If not specified,
	// Google-managed key will be used.
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KmsKeyName") 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. "KmsKeyName") 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:"-"`
}

EncryptionConfig: The encryption options for the Cloud Composer environment and its dependencies.Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.

func (EncryptionConfig) MarshalJSON added in v0.39.0 

func (s EncryptionConfig) MarshalJSON() ([]byte, error)

type Environment 

type Environment struct {
	// Config: Optional. Configuration parameters for this environment.
	Config *EnvironmentConfig `json:"config,omitempty"`
	// CreateTime: Output only. The time at which this environment was created.
	CreateTime string `json:"createTime,omitempty"`
	// Labels: Optional. User-defined labels for this environment. The labels map
	// can contain no more than 64 entries. Entries of the labels map are UTF8
	// strings that comply with the following restrictions: * Keys must conform to
	// regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
	// [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
	// constrained to be <= 128 bytes in size.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Identifier. The resource name of the environment, in the form:
	// "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
	// EnvironmentId must start with a lowercase letter followed by up to 63
	// lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
	Name string `json:"name,omitempty"`
	// SatisfiesPzi: Output only. Reserved for future use.
	SatisfiesPzi bool `json:"satisfiesPzi,omitempty"`
	// SatisfiesPzs: Output only. Reserved for future use.
	SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
	// State: The current state of the environment.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The state of the environment is unknown.
	//   "CREATING" - The environment is in the process of being created.
	//   "RUNNING" - The environment is currently running and healthy. It is ready
	// for use.
	//   "UPDATING" - The environment is being updated. It remains usable but
	// cannot receive additional update requests or be deleted at this time.
	//   "DELETING" - The environment is undergoing deletion. It cannot be used.
	//   "ERROR" - The environment has encountered an error and cannot be used.
	State string `json:"state,omitempty"`
	// StorageConfig: Optional. Storage configuration for this environment.
	StorageConfig *StorageConfig `json:"storageConfig,omitempty"`
	// UpdateTime: Output only. The time at which this environment was last
	// modified.
	UpdateTime string `json:"updateTime,omitempty"`
	// Uuid: Output only. The UUID (Universally Unique IDentifier) associated with
	// this environment. This value is generated when the environment is created.
	Uuid string `json:"uuid,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:"-"`
}

Environment: An environment for running orchestration tasks.

func (Environment) MarshalJSON 

func (s Environment) MarshalJSON() ([]byte, error)

type EnvironmentConfig 

type EnvironmentConfig struct {
	// AirflowByoidUri: Output only. The 'bring your own identity' variant of the
	// URI of the Apache Airflow Web UI hosted within this environment, to be
	// accessed with external identities using workforce identity federation (see
	// Access environments with workforce identity federation
	// (/composer/docs/composer-2/access-environments-with-workforce-identity-federa
	// tion)).
	AirflowByoidUri string `json:"airflowByoidUri,omitempty"`
	// AirflowUri: Output only. The URI of the Apache Airflow Web UI hosted within
	// this environment (see Airflow web interface
	// (/composer/docs/how-to/accessing/airflow-web-interface)).
	AirflowUri string `json:"airflowUri,omitempty"`
	// DagGcsPrefix: Output only. The Cloud Storage prefix of the DAGs for this
	// environment. Although Cloud Storage objects reside in a flat namespace, a
	// hierarchical file tree can be simulated using "/"-delimited object name
	// prefixes. DAG objects for this environment reside in a simulated directory
	// with the given prefix.
	DagGcsPrefix string `json:"dagGcsPrefix,omitempty"`
	// DataRetentionConfig: Optional. The configuration setting for Airflow
	// database data retention mechanism.
	DataRetentionConfig *DataRetentionConfig `json:"dataRetentionConfig,omitempty"`
	// DatabaseConfig: Optional. The configuration settings for Cloud SQL instance
	// used internally by Apache Airflow software.
	DatabaseConfig *DatabaseConfig `json:"databaseConfig,omitempty"`
	// EncryptionConfig: Optional. The encryption options for the Cloud Composer
	// environment and its dependencies. Cannot be updated.
	EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`
	// EnvironmentSize: Optional. The size of the Cloud Composer environment. This
	// field is supported for Cloud Composer environments in versions
	// composer-2.*.*-airflow-*.*.* and newer.
	//
	// Possible values:
	//   "ENVIRONMENT_SIZE_UNSPECIFIED" - The size of the environment is
	// unspecified.
	//   "ENVIRONMENT_SIZE_SMALL" - The environment size is small.
	//   "ENVIRONMENT_SIZE_MEDIUM" - The environment size is medium.
	//   "ENVIRONMENT_SIZE_LARGE" - The environment size is large.
	EnvironmentSize string `json:"environmentSize,omitempty"`
	// GkeCluster: Output only. The Kubernetes Engine cluster used to run this
	// environment.
	GkeCluster string `json:"gkeCluster,omitempty"`
	// MaintenanceWindow: Optional. The maintenance window is the period when Cloud
	// Composer components may undergo maintenance. It is defined so that
	// maintenance is not executed during peak hours or critical time periods. The
	// system will not be under maintenance for every occurrence of this window,
	// but when maintenance is planned, it will be scheduled during the window. The
	// maintenance window period must encompass at least 12 hours per week. This
	// may be split into multiple chunks, each with a size of at least 4 hours. If
	// this value is omitted, the default value for maintenance window is applied.
	// By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on
	// Friday, Saturday, and Sunday every week.
	MaintenanceWindow *MaintenanceWindow `json:"maintenanceWindow,omitempty"`
	// MasterAuthorizedNetworksConfig: Optional. The configuration options for GKE
	// cluster master authorized networks. By default master authorized networks
	// feature is: - in case of private environment: enabled with no external
	// networks allowlisted. - in case of public environment: disabled.
	MasterAuthorizedNetworksConfig *MasterAuthorizedNetworksConfig `json:"masterAuthorizedNetworksConfig,omitempty"`
	// NodeConfig: Optional. The configuration used for the Kubernetes Engine
	// cluster.
	NodeConfig *NodeConfig `json:"nodeConfig,omitempty"`
	// NodeCount: The number of nodes in the Kubernetes Engine cluster that will be
	// used to run this environment. This field is supported for Cloud Composer
	// environments in versions composer-1.*.*-airflow-*.*.*.
	NodeCount int64 `json:"nodeCount,omitempty"`
	// PrivateEnvironmentConfig: Optional. The configuration used for the Private
	// IP Cloud Composer environment.
	PrivateEnvironmentConfig *PrivateEnvironmentConfig `json:"privateEnvironmentConfig,omitempty"`
	// RecoveryConfig: Optional. The Recovery settings configuration of an
	// environment. This field is supported for Cloud Composer environments in
	// versions composer-2.*.*-airflow-*.*.* and newer.
	RecoveryConfig *RecoveryConfig `json:"recoveryConfig,omitempty"`
	// ResilienceMode: Optional. Resilience mode of the Cloud Composer Environment.
	// This field is supported for Cloud Composer environments in versions
	// composer-2.2.0-airflow-*.*.* and newer.
	//
	// Possible values:
	//   "RESILIENCE_MODE_UNSPECIFIED" - Default mode doesn't change environment
	// parameters.
	//   "HIGH_RESILIENCE" - Enabled High Resilience mode, including Cloud SQL HA.
	ResilienceMode string `json:"resilienceMode,omitempty"`
	// SoftwareConfig: Optional. The configuration settings for software inside the
	// environment.
	SoftwareConfig *SoftwareConfig `json:"softwareConfig,omitempty"`
	// WebServerConfig: Optional. The configuration settings for the Airflow web
	// server App Engine instance.
	WebServerConfig *WebServerConfig `json:"webServerConfig,omitempty"`
	// WebServerNetworkAccessControl: Optional. The network-level access control
	// policy for the Airflow web server. If unspecified, no network-level access
	// restrictions will be applied.
	WebServerNetworkAccessControl *WebServerNetworkAccessControl `json:"webServerNetworkAccessControl,omitempty"`
	// WorkloadsConfig: Optional. The workloads configuration settings for the GKE
	// cluster associated with the Cloud Composer environment. The GKE cluster runs
	// Airflow scheduler, web server and workers workloads. This field is supported
	// for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and
	// newer.
	WorkloadsConfig *WorkloadsConfig `json:"workloadsConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AirflowByoidUri") 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. "AirflowByoidUri") 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:"-"`
}

EnvironmentConfig: Configuration information for an environment.

func (EnvironmentConfig) MarshalJSON 

func (s EnvironmentConfig) MarshalJSON() ([]byte, error)

type ExecuteAirflowCommandRequest added in v0.125.0 

type ExecuteAirflowCommandRequest struct {
	// Command: Airflow command.
	Command string `json:"command,omitempty"`
	// Parameters: Parameters for the Airflow command/subcommand as an array of
	// arguments. It may contain positional arguments like `["my-dag-id"]`,
	// key-value parameters like `["--foo=bar"]` or `["--foo","bar"]`, or other
	// flags like `["-f"]`.
	Parameters []string `json:"parameters,omitempty"`
	// Subcommand: Airflow subcommand.
	Subcommand string `json:"subcommand,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Command") 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. "Command") 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:"-"`
}

ExecuteAirflowCommandRequest: Execute Airflow Command request.

func (ExecuteAirflowCommandRequest) MarshalJSON added in v0.125.0 

func (s ExecuteAirflowCommandRequest) MarshalJSON() ([]byte, error)

type ExecuteAirflowCommandResponse added in v0.125.0 

type ExecuteAirflowCommandResponse struct {
	// Error: Error message. Empty if there was no error.
	Error string `json:"error,omitempty"`
	// ExecutionId: The unique ID of the command execution for polling.
	ExecutionId string `json:"executionId,omitempty"`
	// Pod: The name of the pod where the command is executed.
	Pod string `json:"pod,omitempty"`
	// PodNamespace: The namespace of the pod where the command is executed.
	PodNamespace string `json:"podNamespace,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// 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:"-"`
}

ExecuteAirflowCommandResponse: Response to ExecuteAirflowCommandRequest.

func (ExecuteAirflowCommandResponse) MarshalJSON added in v0.125.0 

func (s ExecuteAirflowCommandResponse) MarshalJSON() ([]byte, error)

type ExitInfo added in v0.125.0 

type ExitInfo struct {
	// Error: Error message. Empty if there was no error.
	Error string `json:"error,omitempty"`
	// ExitCode: The exit code from the command execution.
	ExitCode int64 `json:"exitCode,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:"-"`
}

ExitInfo: Information about how a command ended.

func (ExitInfo) MarshalJSON added in v0.125.0 

func (s ExitInfo) MarshalJSON() ([]byte, error)

type FetchDatabasePropertiesResponse added in v0.125.0 

type FetchDatabasePropertiesResponse struct {
	// IsFailoverReplicaAvailable: The availability status of the failover replica.
	// A false status indicates that the failover replica is out of sync. The
	// primary instance can only fail over to the failover replica when the status
	// is true.
	IsFailoverReplicaAvailable bool `json:"isFailoverReplicaAvailable,omitempty"`
	// PrimaryGceZone: The Compute Engine zone that the instance is currently
	// serving from.
	PrimaryGceZone string `json:"primaryGceZone,omitempty"`
	// SecondaryGceZone: The Compute Engine zone that the failover instance is
	// currently serving from for a regional Cloud SQL instance.
	SecondaryGceZone string `json:"secondaryGceZone,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "IsFailoverReplicaAvailable")
	// 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. "IsFailoverReplicaAvailable") 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:"-"`
}

FetchDatabasePropertiesResponse: Response for FetchDatabasePropertiesRequest.

func (FetchDatabasePropertiesResponse) MarshalJSON added in v0.125.0 

func (s FetchDatabasePropertiesResponse) MarshalJSON() ([]byte, error)

type IPAllocationPolicy added in v0.22.0 

type IPAllocationPolicy struct {
	// ClusterIpv4CidrBlock: Optional. The IP address range used to allocate IP
	// addresses to pods in the GKE cluster. For Cloud Composer environments in
	// versions composer-1.*.*-airflow-*.*.*, this field is applicable only when
	// `use_ip_aliases` is true. Set to blank to have GKE choose a range with the
	// default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a
	// specific netmask. Set to a CIDR
	// (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation
	// (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`,
	// `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
	ClusterIpv4CidrBlock string `json:"clusterIpv4CidrBlock,omitempty"`
	// ClusterSecondaryRangeName: Optional. The name of the GKE cluster's secondary
	// range used to allocate IP addresses to pods. For Cloud Composer environments
	// in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when
	// `use_ip_aliases` is true.
	ClusterSecondaryRangeName string `json:"clusterSecondaryRangeName,omitempty"`
	// ServicesIpv4CidrBlock: Optional. The IP address range of the services IP
	// addresses in this GKE cluster. For Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*, this field is applicable only when
	// `use_ip_aliases` is true. Set to blank to have GKE choose a range with the
	// default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a
	// specific netmask. Set to a CIDR
	// (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation
	// (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`,
	// `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
	ServicesIpv4CidrBlock string `json:"servicesIpv4CidrBlock,omitempty"`
	// ServicesSecondaryRangeName: Optional. The name of the services' secondary
	// range used to allocate IP addresses to the GKE cluster. For Cloud Composer
	// environments in versions composer-1.*.*-airflow-*.*.*, this field is
	// applicable only when `use_ip_aliases` is true.
	ServicesSecondaryRangeName string `json:"servicesSecondaryRangeName,omitempty"`
	// UseIpAliases: Optional. Whether or not to enable Alias IPs in the GKE
	// cluster. If `true`, a VPC-native cluster is created. This field is only
	// supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*. Environments in newer versions always use
	// VPC-native GKE clusters.
	UseIpAliases bool `json:"useIpAliases,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ClusterIpv4CidrBlock") 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. "ClusterIpv4CidrBlock") 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:"-"`
}

IPAllocationPolicy: Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.

func (IPAllocationPolicy) MarshalJSON added in v0.22.0 

func (s IPAllocationPolicy) MarshalJSON() ([]byte, error)

type ImageVersion added in v0.2.0 

type ImageVersion struct {
	// CreationDisabled: Whether it is impossible to create an environment with the
	// image version.
	CreationDisabled bool `json:"creationDisabled,omitempty"`
	// ImageVersionId: The string identifier of the ImageVersion, in the form:
	// "composer-x.y.z-airflow-a.b.c"
	ImageVersionId string `json:"imageVersionId,omitempty"`
	// IsDefault: Whether this is the default ImageVersion used by Composer during
	// environment creation if no input ImageVersion is specified.
	IsDefault bool `json:"isDefault,omitempty"`
	// ReleaseDate: The date of the version release.
	ReleaseDate *Date `json:"releaseDate,omitempty"`
	// SupportedPythonVersions: supported python versions
	SupportedPythonVersions []string `json:"supportedPythonVersions,omitempty"`
	// UpgradeDisabled: Whether it is impossible to upgrade an environment running
	// with the image version.
	UpgradeDisabled bool `json:"upgradeDisabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CreationDisabled") 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. "CreationDisabled") 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:"-"`
}

ImageVersion: ImageVersion information

func (ImageVersion) MarshalJSON added in v0.2.0 

func (s ImageVersion) MarshalJSON() ([]byte, error)

type Line added in v0.125.0 

type Line struct {
	// Content: Text content of the log line.
	Content string `json:"content,omitempty"`
	// LineNumber: Number of the line.
	LineNumber int64 `json:"lineNumber,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:"-"`
}

Line: Contains information about a single line from logs.

func (Line) MarshalJSON added in v0.125.0 

func (s Line) MarshalJSON() ([]byte, error)

type ListEnvironmentsResponse 

type ListEnvironmentsResponse struct {
	// Environments: The list of environments returned by a
	// ListEnvironmentsRequest.
	Environments []*Environment `json:"environments,omitempty"`
	// NextPageToken: The page token used to query for the next page if one exists.
	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. "Environments") 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. "Environments") 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:"-"`
}

ListEnvironmentsResponse: The environments in a project and location.

func (ListEnvironmentsResponse) MarshalJSON 

func (s ListEnvironmentsResponse) MarshalJSON() ([]byte, error)

type ListImageVersionsResponse added in v0.2.0 

type ListImageVersionsResponse struct {
	// ImageVersions: The list of supported ImageVersions in a location.
	ImageVersions []*ImageVersion `json:"imageVersions,omitempty"`
	// NextPageToken: The page token used to query for the next page if one exists.
	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. "ImageVersions") 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. "ImageVersions") 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:"-"`
}

ListImageVersionsResponse: The ImageVersions in a project and location.

func (ListImageVersionsResponse) MarshalJSON added in v0.2.0 

func (s ListImageVersionsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse 

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	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:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON 

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListUserWorkloadsConfigMapsResponse added in v0.163.0 

type ListUserWorkloadsConfigMapsResponse struct {
	// NextPageToken: The page token used to query for the next page if one exists.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// UserWorkloadsConfigMaps: The list of ConfigMaps returned by a
	// ListUserWorkloadsConfigMapsRequest.
	UserWorkloadsConfigMaps []*UserWorkloadsConfigMap `json:"userWorkloadsConfigMaps,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:"-"`
}

ListUserWorkloadsConfigMapsResponse: The user workloads ConfigMaps for a given environment.

func (ListUserWorkloadsConfigMapsResponse) MarshalJSON added in v0.163.0 

func (s ListUserWorkloadsConfigMapsResponse) MarshalJSON() ([]byte, error)

type ListUserWorkloadsSecretsResponse added in v0.163.0 

type ListUserWorkloadsSecretsResponse struct {
	// NextPageToken: The page token used to query for the next page if one exists.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// UserWorkloadsSecrets: The list of Secrets returned by a
	// ListUserWorkloadsSecretsRequest.
	UserWorkloadsSecrets []*UserWorkloadsSecret `json:"userWorkloadsSecrets,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:"-"`
}

ListUserWorkloadsSecretsResponse: The user workloads Secrets for a given environment.

func (ListUserWorkloadsSecretsResponse) MarshalJSON added in v0.163.0 

func (s ListUserWorkloadsSecretsResponse) MarshalJSON() ([]byte, error)

type ListWorkloadsResponse added in v0.160.0 

type ListWorkloadsResponse struct {
	// NextPageToken: The page token used to query for the next page if one exists.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Workloads: The list of environment workloads.
	Workloads []*ComposerWorkload `json:"workloads,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:"-"`
}

ListWorkloadsResponse: Response to ListWorkloadsRequest.

func (ListWorkloadsResponse) MarshalJSON added in v0.160.0 

func (s ListWorkloadsResponse) MarshalJSON() ([]byte, error)

type LoadSnapshotRequest added in v0.104.0 

type LoadSnapshotRequest struct {
	// SkipAirflowOverridesSetting: Whether or not to skip setting Airflow
	// overrides when loading the environment's state.
	SkipAirflowOverridesSetting bool `json:"skipAirflowOverridesSetting,omitempty"`
	// SkipEnvironmentVariablesSetting: Whether or not to skip setting environment
	// variables when loading the environment's state.
	SkipEnvironmentVariablesSetting bool `json:"skipEnvironmentVariablesSetting,omitempty"`
	// SkipGcsDataCopying: Whether or not to skip copying Cloud Storage data when
	// loading the environment's state.
	SkipGcsDataCopying bool `json:"skipGcsDataCopying,omitempty"`
	// SkipPypiPackagesInstallation: Whether or not to skip installing Pypi
	// packages when loading the environment's state.
	SkipPypiPackagesInstallation bool `json:"skipPypiPackagesInstallation,omitempty"`
	// SnapshotPath: A Cloud Storage path to a snapshot to load, e.g.:
	// "gs://my-bucket/snapshots/project_location_environment_timestamp".
	SnapshotPath string `json:"snapshotPath,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "SkipAirflowOverridesSetting") 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. "SkipAirflowOverridesSetting") 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:"-"`
}

LoadSnapshotRequest: Request to load a snapshot into a Cloud Composer environment.

func (LoadSnapshotRequest) MarshalJSON added in v0.104.0 

func (s LoadSnapshotRequest) MarshalJSON() ([]byte, error)

type LoadSnapshotResponse added in v0.98.0 

type LoadSnapshotResponse struct {
}

LoadSnapshotResponse: Response to LoadSnapshotRequest.

type MaintenanceWindow added in v0.62.0 

type MaintenanceWindow struct {
	// EndTime: Required. Maintenance window end time. It is used only to calculate
	// the duration of the maintenance window. The value for end-time must be in
	// the future, relative to `start_time`.
	EndTime string `json:"endTime,omitempty"`
	// Recurrence: Required. Maintenance window recurrence. Format is a subset of
	// RFC-5545 (https://tools.ietf.org/html/rfc5545) `RRULE`. The only allowed
	// values for `FREQ` field are `FREQ=DAILY` and `FREQ=WEEKLY;BYDAY=...` Example
	// values: `FREQ=WEEKLY;BYDAY=TU,WE`, `FREQ=DAILY`.
	Recurrence string `json:"recurrence,omitempty"`
	// StartTime: Required. Start time of the first recurrence of the maintenance
	// window.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"`
}

MaintenanceWindow: The configuration settings for Cloud Composer maintenance window. The following example: ``` { "startTime":"2019-08-01T01:00:00Z" "endTime":"2019-08-01T07:00:00Z" "recurrence":"FREQ=WEEKLY;BYDAY=TU,WE" } ``` would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.

func (MaintenanceWindow) MarshalJSON added in v0.62.0 

func (s MaintenanceWindow) MarshalJSON() ([]byte, error)

type MasterAuthorizedNetworksConfig added in v0.80.0 

type MasterAuthorizedNetworksConfig struct {
	// CidrBlocks: Up to 50 external networks that could access Kubernetes master
	// through HTTPS.
	CidrBlocks []*CidrBlock `json:"cidrBlocks,omitempty"`
	// Enabled: Whether or not master authorized networks feature is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CidrBlocks") 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. "CidrBlocks") 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:"-"`
}

MasterAuthorizedNetworksConfig: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.

func (MasterAuthorizedNetworksConfig) MarshalJSON added in v0.80.0 

func (s MasterAuthorizedNetworksConfig) MarshalJSON() ([]byte, error)

type NetworkingConfig added in v0.101.0 

type NetworkingConfig struct {
	// ConnectionType: Optional. Indicates the user requested specifc connection
	// type between Tenant and Customer projects. You cannot set networking
	// connection type in public IP environment.
	//
	// Possible values:
	//   "CONNECTION_TYPE_UNSPECIFIED" - No specific connection type was requested,
	// so the environment uses the default value corresponding to the rest of its
	// configuration.
	//   "VPC_PEERING" - Requests the use of VPC peerings for connecting the
	// Customer and Tenant projects.
	//   "PRIVATE_SERVICE_CONNECT" - Requests the use of Private Service Connect
	// for connecting the Customer and Tenant projects.
	ConnectionType string `json:"connectionType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConnectionType") 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. "ConnectionType") 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:"-"`
}

NetworkingConfig: Configuration options for networking connections in the Composer 2 environment.

func (NetworkingConfig) MarshalJSON added in v0.101.0 

func (s NetworkingConfig) MarshalJSON() ([]byte, error)

type NodeConfig 

type NodeConfig struct {
	// ComposerInternalIpv4CidrBlock: Optional. The IP range in CIDR notation to
	// use internally by Cloud Composer. IP addresses are not reserved - and the
	// same range can be used by multiple Cloud Composer environments. In case of
	// overlap, IPs from this range will not be accessible in the user's VPC
	// network. Cannot be updated. If not specified, the default value of
	// '100.64.128.0/20' is used. This field is supported for Cloud Composer
	// environments in versions composer-3.*.*-airflow-*.*.* and newer.
	ComposerInternalIpv4CidrBlock string `json:"composerInternalIpv4CidrBlock,omitempty"`
	// ComposerNetworkAttachment: Optional. Network Attachment that Cloud Composer
	// environment is connected to, which provides connectivity with a user's VPC
	// network. Takes precedence over network and subnetwork settings. If not
	// provided, but network and subnetwork are defined during environment, it will
	// be provisioned. If not provided and network and subnetwork are also empty,
	// then connectivity to user's VPC network is disabled. Network attachment must
	// be provided in format
	// projects/{project}/regions/{region}/networkAttachments/{networkAttachment}.
	// This field is supported for Cloud Composer environments in versions
	// composer-3.*.*-airflow-*.*.* and newer.
	ComposerNetworkAttachment string `json:"composerNetworkAttachment,omitempty"`
	// DiskSizeGb: Optional. The disk size in GB used for node VMs. Minimum size is
	// 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is
	// supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*.
	DiskSizeGb int64 `json:"diskSizeGb,omitempty"`
	// EnableIpMasqAgent: Optional. Deploys 'ip-masq-agent' daemon set in the GKE
	// cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP
	// masquerading is used for all destination addresses, except between pods
	// traffic. See:
	// https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
	EnableIpMasqAgent bool `json:"enableIpMasqAgent,omitempty"`
	// IpAllocationPolicy: Optional. The configuration for controlling how IPs are
	// allocated in the GKE cluster.
	IpAllocationPolicy *IPAllocationPolicy `json:"ipAllocationPolicy,omitempty"`
	// Location: Optional. The Compute Engine zone (/compute/docs/regions-zones) in
	// which to deploy the VMs used to run the Apache Airflow software, specified
	// as a relative resource name
	// (/apis/design/resource_names#relative_resource_name). For example:
	// "projects/{projectId}/zones/{zoneId}". This `location` must belong to the
	// enclosing environment's project and location. If both this field and
	// `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong
	// to this `location`; if both are unspecified, the service will pick a zone in
	// the Compute Engine region corresponding to the Cloud Composer location, and
	// propagate that choice to both fields. If only one field (`location` or
	// `nodeConfig.machineType`) is specified, the location information from the
	// specified field will be propagated to the unspecified field. This field is
	// supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*.
	Location string `json:"location,omitempty"`
	// MachineType: Optional. The Compute Engine machine type
	// (/compute/docs/machine-types) used for cluster instances, specified as a
	// relative resource name (/apis/design/resource_names#relative_resource_name).
	// For example:
	// "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The
	// `machineType` must belong to the enclosing environment's project and
	// location. If both this field and `nodeConfig.location` are specified, this
	// `machineType` must belong to the `nodeConfig.location`; if both are
	// unspecified, the service will pick a zone in the Compute Engine region
	// corresponding to the Cloud Composer location, and propagate that choice to
	// both fields. If exactly one of this field and `nodeConfig.location` is
	// specified, the location information from the specified field will be
	// propagated to the unspecified field. The `machineTypeId` must not be a
	// shared-core machine type (/compute/docs/machine-types#sharedcore). If this
	// field is unspecified, the `machineTypeId` defaults to "n1-standard-1". This
	// field is supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*.
	MachineType string `json:"machineType,omitempty"`
	// Network: Optional. The Compute Engine network to be used for machine
	// communications, specified as a relative resource name
	// (/apis/design/resource_names#relative_resource_name). For example:
	// "projects/{projectId}/global/networks/{networkId}". If unspecified, the
	// "default" network ID in the environment's project is used. If a Custom
	// Subnet Network (/vpc/docs/vpc#vpc_networks_and_subnets) is provided,
	// `nodeConfig.subnetwork` must also be provided. For Shared VPC
	// (/vpc/docs/shared-vpc) subnetwork requirements, see `nodeConfig.subnetwork`.
	Network string `json:"network,omitempty"`
	// OauthScopes: Optional. The set of Google API scopes to be made available on
	// all node VMs. If `oauth_scopes` is empty, defaults to
	// ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. This
	// field is supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*.
	OauthScopes []string `json:"oauthScopes,omitempty"`
	// ServiceAccount: Optional. The Google Cloud Platform Service Account to be
	// used by the node VMs. If a service account is not specified, the "default"
	// Compute Engine service account is used. Cannot be updated.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// Subnetwork: Optional. The Compute Engine subnetwork to be used for machine
	// communications, specified as a relative resource name
	// (/apis/design/resource_names#relative_resource_name). For example:
	// "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a
	// subnetwork is provided, `nodeConfig.network` must also be provided, and the
	// subnetwork must belong to the enclosing environment's project and location.
	Subnetwork string `json:"subnetwork,omitempty"`
	// Tags: Optional. The list of instance tags applied to all node VMs. Tags are
	// used to identify valid sources or targets for network firewalls. Each tag
	// within the list must comply with RFC1035
	// (https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated.
	Tags []string `json:"tags,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "ComposerInternalIpv4CidrBlock") 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. "ComposerInternalIpv4CidrBlock")
	// 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:"-"`
}

NodeConfig: The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.

func (NodeConfig) MarshalJSON 

func (s NodeConfig) MarshalJSON() ([]byte, error)

type Operation 

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON 

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata 

type OperationMetadata struct {
	// CreateTime: Output only. The time the operation was submitted to the server.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time when the operation terminated, regardless of
	// its success. This field is unset if the operation is still ongoing.
	EndTime string `json:"endTime,omitempty"`
	// OperationType: Output only. The type of operation being performed.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Unused.
	//   "CREATE" - A resource creation operation.
	//   "DELETE" - A resource deletion operation.
	//   "UPDATE" - A resource update operation.
	//   "CHECK" - A resource check operation.
	//   "SAVE_SNAPSHOT" - Saves snapshot of the resource operation.
	//   "LOAD_SNAPSHOT" - Loads snapshot of the resource operation.
	//   "DATABASE_FAILOVER" - Triggers failover of environment's Cloud SQL
	// instance (only for highly resilient environments).
	OperationType string `json:"operationType,omitempty"`
	// Resource: Output only. The resource being operated on, as a relative
	// resource name ( /apis/design/resource_names#relative_resource_name).
	Resource string `json:"resource,omitempty"`
	// ResourceUuid: Output only. The UUID of the resource being operated on.
	ResourceUuid string `json:"resourceUuid,omitempty"`
	// State: Output only. The current operation state.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unused.
	//   "PENDING" - The operation has been created but is not yet started.
	//   "RUNNING" - The operation is underway.
	//   "SUCCEEDED" - The operation completed successfully.
	//   "SUCCESSFUL"
	//   "FAILED" - The operation is no longer running but did not succeed.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}

OperationMetadata: Metadata describing an operation.

func (OperationMetadata) MarshalJSON 

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type PollAirflowCommandRequest added in v0.125.0 

type PollAirflowCommandRequest struct {
	// ExecutionId: The unique ID of the command execution.
	ExecutionId string `json:"executionId,omitempty"`
	// NextLineNumber: Line number from which new logs should be fetched.
	NextLineNumber int64 `json:"nextLineNumber,omitempty"`
	// Pod: The name of the pod where the command is executed.
	Pod string `json:"pod,omitempty"`
	// PodNamespace: The namespace of the pod where the command is executed.
	PodNamespace string `json:"podNamespace,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExecutionId") 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. "ExecutionId") 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:"-"`
}

PollAirflowCommandRequest: Poll Airflow Command request.

func (PollAirflowCommandRequest) MarshalJSON added in v0.125.0 

func (s PollAirflowCommandRequest) MarshalJSON() ([]byte, error)

type PollAirflowCommandResponse added in v0.125.0 

type PollAirflowCommandResponse struct {
	// ExitInfo: The result exit status of the command.
	ExitInfo *ExitInfo `json:"exitInfo,omitempty"`
	// Output: Output from the command execution. It may not contain the full
	// output and the caller may need to poll for more lines.
	Output []*Line `json:"output,omitempty"`
	// OutputEnd: Whether the command execution has finished and there is no more
	// output.
	OutputEnd bool `json:"outputEnd,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ExitInfo") 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. "ExitInfo") 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:"-"`
}

PollAirflowCommandResponse: Response to PollAirflowCommandRequest.

func (PollAirflowCommandResponse) MarshalJSON added in v0.125.0 

func (s PollAirflowCommandResponse) MarshalJSON() ([]byte, error)

type PrivateClusterConfig added in v0.22.0 

type PrivateClusterConfig struct {
	// EnablePrivateEndpoint: Optional. If `true`, access to the public endpoint of
	// the GKE cluster is denied.
	EnablePrivateEndpoint bool `json:"enablePrivateEndpoint,omitempty"`
	// MasterIpv4CidrBlock: Optional. The CIDR block from which IPv4 range for GKE
	// master will be reserved. If left blank, the default value of '172.16.0.0/23'
	// is used.
	MasterIpv4CidrBlock string `json:"masterIpv4CidrBlock,omitempty"`
	// MasterIpv4ReservedRange: Output only. The IP range in CIDR notation to use
	// for the hosted master network. This range is used for assigning internal IP
	// addresses to the GKE cluster master or set of masters and to the internal
	// load balancer virtual IP. This range must not overlap with any other ranges
	// in use within the cluster's network.
	MasterIpv4ReservedRange string `json:"masterIpv4ReservedRange,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnablePrivateEndpoint") 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. "EnablePrivateEndpoint") 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:"-"`
}

PrivateClusterConfig: Configuration options for the private GKE cluster in a Cloud Composer environment.

func (PrivateClusterConfig) MarshalJSON added in v0.22.0 

func (s PrivateClusterConfig) MarshalJSON() ([]byte, error)

type PrivateEnvironmentConfig added in v0.22.0 

type PrivateEnvironmentConfig struct {
	// CloudComposerConnectionSubnetwork: Optional. When specified, the environment
	// will use Private Service Connect instead of VPC peerings to connect to Cloud
	// SQL in the Tenant Project, and the PSC endpoint in the Customer Project will
	// use an IP address from this subnetwork.
	CloudComposerConnectionSubnetwork string `json:"cloudComposerConnectionSubnetwork,omitempty"`
	// CloudComposerNetworkIpv4CidrBlock: Optional. The CIDR block from which IP
	// range for Cloud Composer Network in tenant project will be reserved. Needs
	// to be disjoint from private_cluster_config.master_ipv4_cidr_block and
	// cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer
	// environments in versions composer-2.*.*-airflow-*.*.* and newer.
	CloudComposerNetworkIpv4CidrBlock string `json:"cloudComposerNetworkIpv4CidrBlock,omitempty"`
	// CloudComposerNetworkIpv4ReservedRange: Output only. The IP range reserved
	// for the tenant project's Cloud Composer network. This field is supported for
	// Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and
	// newer.
	CloudComposerNetworkIpv4ReservedRange string `json:"cloudComposerNetworkIpv4ReservedRange,omitempty"`
	// CloudSqlIpv4CidrBlock: Optional. The CIDR block from which IP range in
	// tenant project will be reserved for Cloud SQL. Needs to be disjoint from
	// `web_server_ipv4_cidr_block`.
	CloudSqlIpv4CidrBlock string `json:"cloudSqlIpv4CidrBlock,omitempty"`
	// EnablePrivateBuildsOnly: Optional. If `true`, builds performed during
	// operations that install Python packages have only private connectivity to
	// Google services (including Artifact Registry) and VPC network (if either
	// `NodeConfig.network` and `NodeConfig.subnetwork` fields or
	// `NodeConfig.composer_network_attachment` field are specified). If `false`,
	// the builds also have access to the internet. This field is supported for
	// Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and
	// newer.
	EnablePrivateBuildsOnly bool `json:"enablePrivateBuildsOnly,omitempty"`
	// EnablePrivateEnvironment: Optional. If `true`, a Private IP Cloud Composer
	// environment is created. If this field is set to true,
	// `IPAllocationPolicy.use_ip_aliases` must be set to true for Cloud Composer
	// environments in versions composer-1.*.*-airflow-*.*.*.
	EnablePrivateEnvironment bool `json:"enablePrivateEnvironment,omitempty"`
	// EnablePrivatelyUsedPublicIps: Optional. When enabled, IPs from public
	// (non-RFC1918) ranges can be used for
	// `IPAllocationPolicy.cluster_ipv4_cidr_block` and
	// `IPAllocationPolicy.service_ipv4_cidr_block`.
	EnablePrivatelyUsedPublicIps bool `json:"enablePrivatelyUsedPublicIps,omitempty"`
	// NetworkingConfig: Optional. Configuration for the network connections
	// configuration in the environment.
	NetworkingConfig *NetworkingConfig `json:"networkingConfig,omitempty"`
	// PrivateClusterConfig: Optional. Configuration for the private GKE cluster
	// for a Private IP Cloud Composer environment.
	PrivateClusterConfig *PrivateClusterConfig `json:"privateClusterConfig,omitempty"`
	// WebServerIpv4CidrBlock: Optional. The CIDR block from which IP range for web
	// server will be reserved. Needs to be disjoint from
	// `private_cluster_config.master_ipv4_cidr_block` and
	// `cloud_sql_ipv4_cidr_block`. This field is supported for Cloud Composer
	// environments in versions composer-1.*.*-airflow-*.*.*.
	WebServerIpv4CidrBlock string `json:"webServerIpv4CidrBlock,omitempty"`
	// WebServerIpv4ReservedRange: Output only. The IP range reserved for the
	// tenant project's App Engine VMs. This field is supported for Cloud Composer
	// environments in versions composer-1.*.*-airflow-*.*.*.
	WebServerIpv4ReservedRange string `json:"webServerIpv4ReservedRange,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "CloudComposerConnectionSubnetwork") 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.
	// "CloudComposerConnectionSubnetwork") 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:"-"`
}

PrivateEnvironmentConfig: The configuration information for configuring a Private IP Cloud Composer environment.

func (PrivateEnvironmentConfig) MarshalJSON added in v0.22.0 

func (s PrivateEnvironmentConfig) MarshalJSON() ([]byte, error)

type ProjectsLocationsEnvironmentsCheckUpgradeCall added in v0.182.0 

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

func (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Context added in v0.182.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Do added in v0.182.0 

func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.environments.checkUpgrade" 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 (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Fields added in v0.182.0 

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

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

func (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Header added in v0.182.0 

func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsCreateCall 

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

func (*ProjectsLocationsEnvironmentsCreateCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsCreateCall) Do 

func (c *ProjectsLocationsEnvironmentsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.environments.create" 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 (*ProjectsLocationsEnvironmentsCreateCall) Fields 

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

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

func (*ProjectsLocationsEnvironmentsCreateCall) Header 

func (c *ProjectsLocationsEnvironmentsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsDatabaseFailoverCall added in v0.125.0 

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

func (*ProjectsLocationsEnvironmentsDatabaseFailoverCall) Context added in v0.125.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsDatabaseFailoverCall) Do added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.environments.databaseFailover" 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 (*ProjectsLocationsEnvironmentsDatabaseFailoverCall) Fields added in v0.125.0 

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

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

func (*ProjectsLocationsEnvironmentsDatabaseFailoverCall) Header added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsDeleteCall 

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

func (*ProjectsLocationsEnvironmentsDeleteCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsDeleteCall) Do 

func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.environments.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 (*ProjectsLocationsEnvironmentsDeleteCall) Fields 

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

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

func (*ProjectsLocationsEnvironmentsDeleteCall) Header 

func (c *ProjectsLocationsEnvironmentsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsExecuteAirflowCommandCall added in v0.125.0 

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

func (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Context added in v0.125.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Do added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Do(opts ...googleapi.CallOption) (*ExecuteAirflowCommandResponse, error)

Do executes the "composer.projects.locations.environments.executeAirflowCommand" call. Any non-2xx status code is an error. Response headers are in either *ExecuteAirflowCommandResponse.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 (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Fields added in v0.125.0 

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

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

func (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Header added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall added in v0.125.0 

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

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Context added in v0.125.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Do added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Do(opts ...googleapi.CallOption) (*FetchDatabasePropertiesResponse, error)

Do executes the "composer.projects.locations.environments.fetchDatabaseProperties" call. Any non-2xx status code is an error. Response headers are in either *FetchDatabasePropertiesResponse.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 (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Fields added in v0.125.0 

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

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

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Header added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) IfNoneMatch added in v0.125.0 

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

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 ProjectsLocationsEnvironmentsGetCall 

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

func (*ProjectsLocationsEnvironmentsGetCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsGetCall) Do 

func (c *ProjectsLocationsEnvironmentsGetCall) Do(opts ...googleapi.CallOption) (*Environment, error)

Do executes the "composer.projects.locations.environments.get" call. Any non-2xx status code is an error. Response headers are in either *Environment.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 (*ProjectsLocationsEnvironmentsGetCall) Fields 

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

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

func (*ProjectsLocationsEnvironmentsGetCall) Header 

func (c *ProjectsLocationsEnvironmentsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsGetCall) IfNoneMatch 

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

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 ProjectsLocationsEnvironmentsListCall 

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

func (*ProjectsLocationsEnvironmentsListCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsListCall) Do 

func (c *ProjectsLocationsEnvironmentsListCall) Do(opts ...googleapi.CallOption) (*ListEnvironmentsResponse, error)

Do executes the "composer.projects.locations.environments.list" call. Any non-2xx status code is an error. Response headers are in either *ListEnvironmentsResponse.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 (*ProjectsLocationsEnvironmentsListCall) Fields 

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

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

func (*ProjectsLocationsEnvironmentsListCall) Header 

func (c *ProjectsLocationsEnvironmentsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsListCall) IfNoneMatch 

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

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 (*ProjectsLocationsEnvironmentsListCall) PageSize 

func (c *ProjectsLocationsEnvironmentsListCall) PageSize(pageSize int64) *ProjectsLocationsEnvironmentsListCall

PageSize sets the optional parameter "pageSize": The maximum number of environments to return.

func (*ProjectsLocationsEnvironmentsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsEnvironmentsListCall) Pages 

func (c *ProjectsLocationsEnvironmentsListCall) Pages(ctx context.Context, f func(*ListEnvironmentsResponse) 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.

type ProjectsLocationsEnvironmentsLoadSnapshotCall added in v0.104.0 

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

func (*ProjectsLocationsEnvironmentsLoadSnapshotCall) Context added in v0.104.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsLoadSnapshotCall) Do added in v0.104.0 

func (c *ProjectsLocationsEnvironmentsLoadSnapshotCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.environments.loadSnapshot" 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 (*ProjectsLocationsEnvironmentsLoadSnapshotCall) Fields added in v0.104.0 

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

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

func (*ProjectsLocationsEnvironmentsLoadSnapshotCall) Header added in v0.104.0 

func (c *ProjectsLocationsEnvironmentsLoadSnapshotCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsPatchCall 

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

func (*ProjectsLocationsEnvironmentsPatchCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsPatchCall) Do 

func (c *ProjectsLocationsEnvironmentsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.environments.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 (*ProjectsLocationsEnvironmentsPatchCall) Fields 

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

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

func (*ProjectsLocationsEnvironmentsPatchCall) Header 

func (c *ProjectsLocationsEnvironmentsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsPatchCall) UpdateMask 

func (c *ProjectsLocationsEnvironmentsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsEnvironmentsPatchCall

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:** Only the following fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI package *packagename*, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the `config.softwareConfig.pypiPackages` mask. * `labels` * Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * `labels.`labelName * Set the label named *labelName*, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the `labels` mask. * `config.nodeCount` * Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerNetworkAccessControl` * Replace the environment's current `WebServerNetworkAccessControl`. * `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the Apache Airflow config property *name* in the section named *section*, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the `config.softwareConfig.airflowConfigOverrides` mask. * `config.softwareConfig.envVariables` * Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. * `config.softwareConfig.schedulerCount` * Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the `config.softwareConfig.schedulerCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerConfig.machineType` * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.

type ProjectsLocationsEnvironmentsPollAirflowCommandCall added in v0.125.0 

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

func (*ProjectsLocationsEnvironmentsPollAirflowCommandCall) Context added in v0.125.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsPollAirflowCommandCall) Do added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Do(opts ...googleapi.CallOption) (*PollAirflowCommandResponse, error)

Do executes the "composer.projects.locations.environments.pollAirflowCommand" call. Any non-2xx status code is an error. Response headers are in either *PollAirflowCommandResponse.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 (*ProjectsLocationsEnvironmentsPollAirflowCommandCall) Fields added in v0.125.0 

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

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

func (*ProjectsLocationsEnvironmentsPollAirflowCommandCall) Header added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsSaveSnapshotCall added in v0.104.0 

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

func (*ProjectsLocationsEnvironmentsSaveSnapshotCall) Context added in v0.104.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsSaveSnapshotCall) Do added in v0.104.0 

func (c *ProjectsLocationsEnvironmentsSaveSnapshotCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.environments.saveSnapshot" 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 (*ProjectsLocationsEnvironmentsSaveSnapshotCall) Fields added in v0.104.0 

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

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

func (*ProjectsLocationsEnvironmentsSaveSnapshotCall) Header added in v0.104.0 

func (c *ProjectsLocationsEnvironmentsSaveSnapshotCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsService 

type ProjectsLocationsEnvironmentsService struct {
	UserWorkloadsConfigMaps *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService

	UserWorkloadsSecrets *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService

	Workloads *ProjectsLocationsEnvironmentsWorkloadsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsEnvironmentsService 

func NewProjectsLocationsEnvironmentsService(s *Service) *ProjectsLocationsEnvironmentsService

func (*ProjectsLocationsEnvironmentsService) CheckUpgrade added in v0.182.0 

func (r *ProjectsLocationsEnvironmentsService) CheckUpgrade(environment string, checkupgraderequest *CheckUpgradeRequest) *ProjectsLocationsEnvironmentsCheckUpgradeCall

CheckUpgrade: Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.

  • environment: The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) Create 

func (r *ProjectsLocationsEnvironmentsService) Create(parent string, environment *Environment) *ProjectsLocationsEnvironmentsCreateCall

Create: Create a new environment.

  • parent: The parent must be of the form "projects/{projectId}/locations/{locationId}".

func (*ProjectsLocationsEnvironmentsService) DatabaseFailover added in v0.125.0 

func (r *ProjectsLocationsEnvironmentsService) DatabaseFailover(environment string, databasefailoverrequest *DatabaseFailoverRequest) *ProjectsLocationsEnvironmentsDatabaseFailoverCall

DatabaseFailover: Triggers database failover (only for highly resilient environments).

  • environment: Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) Delete 

func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall

Delete: Delete an environment.

  • name: The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) ExecuteAirflowCommand added in v0.125.0 

func (r *ProjectsLocationsEnvironmentsService) ExecuteAirflowCommand(environment string, executeairflowcommandrequest *ExecuteAirflowCommandRequest) *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall

ExecuteAirflowCommand: Executes Airflow CLI command.

  • environment: The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) FetchDatabaseProperties added in v0.125.0 

func (r *ProjectsLocationsEnvironmentsService) FetchDatabaseProperties(environment string) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall

FetchDatabaseProperties: Fetches database properties.

  • environment: The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) Get 

func (r *ProjectsLocationsEnvironmentsService) Get(name string) *ProjectsLocationsEnvironmentsGetCall

Get: Get an existing environment.

  • name: The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) List 

func (r *ProjectsLocationsEnvironmentsService) List(parent string) *ProjectsLocationsEnvironmentsListCall

List: List environments.

  • parent: List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}".

func (*ProjectsLocationsEnvironmentsService) LoadSnapshot added in v0.104.0 

func (r *ProjectsLocationsEnvironmentsService) LoadSnapshot(environment string, loadsnapshotrequest *LoadSnapshotRequest) *ProjectsLocationsEnvironmentsLoadSnapshotCall

LoadSnapshot: Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.

  • environment: The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) Patch 

func (r *ProjectsLocationsEnvironmentsService) Patch(name string, environment *Environment) *ProjectsLocationsEnvironmentsPatchCall

Patch: Update an environment.

  • name: The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) PollAirflowCommand added in v0.125.0 

func (r *ProjectsLocationsEnvironmentsService) PollAirflowCommand(environment string, pollairflowcommandrequest *PollAirflowCommandRequest) *ProjectsLocationsEnvironmentsPollAirflowCommandCall

PollAirflowCommand: Polls Airflow CLI command execution and fetches logs.

  • environment: The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) SaveSnapshot added in v0.104.0 

func (r *ProjectsLocationsEnvironmentsService) SaveSnapshot(environment string, savesnapshotrequest *SaveSnapshotRequest) *ProjectsLocationsEnvironmentsSaveSnapshotCall

SaveSnapshot: Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.

  • environment: The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService) StopAirflowCommand added in v0.125.0 

func (r *ProjectsLocationsEnvironmentsService) StopAirflowCommand(environment string, stopairflowcommandrequest *StopAirflowCommandRequest) *ProjectsLocationsEnvironmentsStopAirflowCommandCall

StopAirflowCommand: Stops Airflow CLI command execution.

  • environment: The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

type ProjectsLocationsEnvironmentsStopAirflowCommandCall added in v0.125.0 

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

func (*ProjectsLocationsEnvironmentsStopAirflowCommandCall) Context added in v0.125.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsStopAirflowCommandCall) Do added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Do(opts ...googleapi.CallOption) (*StopAirflowCommandResponse, error)

Do executes the "composer.projects.locations.environments.stopAirflowCommand" call. Any non-2xx status code is an error. Response headers are in either *StopAirflowCommandResponse.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 (*ProjectsLocationsEnvironmentsStopAirflowCommandCall) Fields added in v0.125.0 

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

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

func (*ProjectsLocationsEnvironmentsStopAirflowCommandCall) Header added in v0.125.0 

func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall) Do(opts ...googleapi.CallOption) (*UserWorkloadsConfigMap, error)

Do executes the "composer.projects.locations.environments.userWorkloadsConfigMaps.create" call. Any non-2xx status code is an error. Response headers are in either *UserWorkloadsConfigMap.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 (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "composer.projects.locations.environments.userWorkloadsConfigMaps.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall) Do(opts ...googleapi.CallOption) (*UserWorkloadsConfigMap, error)

Do executes the "composer.projects.locations.environments.userWorkloadsConfigMaps.get" call. Any non-2xx status code is an error. Response headers are in either *UserWorkloadsConfigMap.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 (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall) IfNoneMatch added in v0.163.0 

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

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 ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Do(opts ...googleapi.CallOption) (*ListUserWorkloadsConfigMapsResponse, error)

Do executes the "composer.projects.locations.environments.userWorkloadsConfigMaps.list" call. Any non-2xx status code is an error. Response headers are in either *ListUserWorkloadsConfigMapsResponse.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 (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) IfNoneMatch added in v0.163.0 

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

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 (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) PageSize added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) PageSize(pageSize int64) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall

PageSize sets the optional parameter "pageSize": The maximum number of ConfigMaps to return.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) PageToken added in v0.163.0 

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

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Pages added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall) Pages(ctx context.Context, f func(*ListUserWorkloadsConfigMapsResponse) 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.

type ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService added in v0.163.0 

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

func NewProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService added in v0.163.0 

func NewProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService(s *Service) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Create added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Create(parent string, userworkloadsconfigmap *UserWorkloadsConfigMap) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall

Create: Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • parent: The environment name to create a ConfigMap for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Delete added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Delete(name string) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall

Delete: Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • name: The ConfigMap to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/u serWorkloadsConfigMaps/{userWorkloadsConfigMapId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Get added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Get(name string) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall

Get: Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • name: The resource name of the ConfigMap to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/u serWorkloadsConfigMaps/{userWorkloadsConfigMapId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) List added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) List(parent string) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall

List: Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • parent: List ConfigMaps in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Update added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService) Update(name string, userworkloadsconfigmap *UserWorkloadsConfigMap) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall

Update: Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • name: Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/u serWorkloadsConfigMaps/{userWorkloadsConfigMapId}".

type ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall) Do(opts ...googleapi.CallOption) (*UserWorkloadsConfigMap, error)

Do executes the "composer.projects.locations.environments.userWorkloadsConfigMaps.update" call. Any non-2xx status code is an error. Response headers are in either *UserWorkloadsConfigMap.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 (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall) Do(opts ...googleapi.CallOption) (*UserWorkloadsSecret, error)

Do executes the "composer.projects.locations.environments.userWorkloadsSecrets.create" call. Any non-2xx status code is an error. Response headers are in either *UserWorkloadsSecret.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 (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "composer.projects.locations.environments.userWorkloadsSecrets.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall) Do(opts ...googleapi.CallOption) (*UserWorkloadsSecret, error)

Do executes the "composer.projects.locations.environments.userWorkloadsSecrets.get" call. Any non-2xx status code is an error. Response headers are in either *UserWorkloadsSecret.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 (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall) IfNoneMatch added in v0.163.0 

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

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 ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Do(opts ...googleapi.CallOption) (*ListUserWorkloadsSecretsResponse, error)

Do executes the "composer.projects.locations.environments.userWorkloadsSecrets.list" call. Any non-2xx status code is an error. Response headers are in either *ListUserWorkloadsSecretsResponse.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 (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) IfNoneMatch added in v0.163.0 

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

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 (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) PageSize added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) PageSize(pageSize int64) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall

PageSize sets the optional parameter "pageSize": The maximum number of Secrets to return.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) PageToken added in v0.163.0 

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

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Pages added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall) Pages(ctx context.Context, f func(*ListUserWorkloadsSecretsResponse) 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.

type ProjectsLocationsEnvironmentsUserWorkloadsSecretsService added in v0.163.0 

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

func NewProjectsLocationsEnvironmentsUserWorkloadsSecretsService added in v0.163.0 

func NewProjectsLocationsEnvironmentsUserWorkloadsSecretsService(s *Service) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Create added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Create(parent string, userworkloadssecret *UserWorkloadsSecret) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall

Create: Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • parent: The environment name to create a Secret for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Delete added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Delete(name string) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall

Delete: Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • name: The Secret to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/u serWorkloadsSecrets/{userWorkloadsSecretId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Get added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Get(name string) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall

Get: Gets an existing user workloads Secret. Values of the "data" field in the response are cleared. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • name: The resource name of the Secret to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/u serWorkloadsSecrets/{userWorkloadsSecretId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) List added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) List(parent string) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall

List: Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • parent: List Secrets in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Update added in v0.163.0 

func (r *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService) Update(name string, userworkloadssecret *UserWorkloadsSecret) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall

Update: Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • name: Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/u serWorkloadsSecrets/{userWorkloadsSecretId}".

type ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall added in v0.163.0 

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall) Context added in v0.163.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall) Do added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall) Do(opts ...googleapi.CallOption) (*UserWorkloadsSecret, error)

Do executes the "composer.projects.locations.environments.userWorkloadsSecrets.update" call. Any non-2xx status code is an error. Response headers are in either *UserWorkloadsSecret.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 (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall) Fields added in v0.163.0 

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall) Header added in v0.163.0 

func (c *ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEnvironmentsWorkloadsListCall added in v0.160.0 

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall) Context added in v0.160.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall) Do added in v0.160.0 

func (c *ProjectsLocationsEnvironmentsWorkloadsListCall) Do(opts ...googleapi.CallOption) (*ListWorkloadsResponse, error)

Do executes the "composer.projects.locations.environments.workloads.list" call. Any non-2xx status code is an error. Response headers are in either *ListWorkloadsResponse.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 (*ProjectsLocationsEnvironmentsWorkloadsListCall) Fields added in v0.160.0 

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

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall) Filter added in v0.160.0 

func (c *ProjectsLocationsEnvironmentsWorkloadsListCall) Filter(filter string) *ProjectsLocationsEnvironmentsWorkloadsListCall

Filter sets the optional parameter "filter": The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall) Header added in v0.160.0 

func (c *ProjectsLocationsEnvironmentsWorkloadsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall) IfNoneMatch added in v0.160.0 

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

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 (*ProjectsLocationsEnvironmentsWorkloadsListCall) PageSize added in v0.160.0 

func (c *ProjectsLocationsEnvironmentsWorkloadsListCall) PageSize(pageSize int64) *ProjectsLocationsEnvironmentsWorkloadsListCall

PageSize sets the optional parameter "pageSize": The maximum number of environments to return.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall) PageToken added in v0.160.0 

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

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall) Pages added in v0.160.0 

func (c *ProjectsLocationsEnvironmentsWorkloadsListCall) Pages(ctx context.Context, f func(*ListWorkloadsResponse) 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.

type ProjectsLocationsEnvironmentsWorkloadsService added in v0.160.0 

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

func NewProjectsLocationsEnvironmentsWorkloadsService added in v0.160.0 

func NewProjectsLocationsEnvironmentsWorkloadsService(s *Service) *ProjectsLocationsEnvironmentsWorkloadsService

func (*ProjectsLocationsEnvironmentsWorkloadsService) List added in v0.160.0 

func (r *ProjectsLocationsEnvironmentsWorkloadsService) List(parent string) *ProjectsLocationsEnvironmentsWorkloadsListCall

List: Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

  • parent: The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

type ProjectsLocationsImageVersionsListCall added in v0.2.0 

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

func (*ProjectsLocationsImageVersionsListCall) Context added in v0.2.0 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsImageVersionsListCall) Do added in v0.2.0 

func (c *ProjectsLocationsImageVersionsListCall) Do(opts ...googleapi.CallOption) (*ListImageVersionsResponse, error)

Do executes the "composer.projects.locations.imageVersions.list" call. Any non-2xx status code is an error. Response headers are in either *ListImageVersionsResponse.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 (*ProjectsLocationsImageVersionsListCall) Fields added in v0.2.0 

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

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

func (*ProjectsLocationsImageVersionsListCall) Header added in v0.2.0 

func (c *ProjectsLocationsImageVersionsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsImageVersionsListCall) IfNoneMatch added in v0.2.0 

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

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 (*ProjectsLocationsImageVersionsListCall) IncludePastReleases added in v0.37.0 

func (c *ProjectsLocationsImageVersionsListCall) IncludePastReleases(includePastReleases bool) *ProjectsLocationsImageVersionsListCall

IncludePastReleases sets the optional parameter "includePastReleases": Whether or not image versions from old releases should be included.

func (*ProjectsLocationsImageVersionsListCall) PageSize added in v0.2.0 

func (c *ProjectsLocationsImageVersionsListCall) PageSize(pageSize int64) *ProjectsLocationsImageVersionsListCall

PageSize sets the optional parameter "pageSize": The maximum number of image_versions to return.

func (*ProjectsLocationsImageVersionsListCall) PageToken added in v0.2.0 

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

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsImageVersionsListCall) Pages added in v0.2.0 

func (c *ProjectsLocationsImageVersionsListCall) Pages(ctx context.Context, f func(*ListImageVersionsResponse) 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.

type ProjectsLocationsImageVersionsService added in v0.2.0 

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

func NewProjectsLocationsImageVersionsService added in v0.2.0 

func NewProjectsLocationsImageVersionsService(s *Service) *ProjectsLocationsImageVersionsService

func (*ProjectsLocationsImageVersionsService) List added in v0.2.0 

func (r *ProjectsLocationsImageVersionsService) List(parent string) *ProjectsLocationsImageVersionsListCall

List: List ImageVersions for provided location.

  • parent: List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}".

type ProjectsLocationsOperationsDeleteCall 

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

func (*ProjectsLocationsOperationsDeleteCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall) Do 

func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "composer.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsOperationsDeleteCall) Fields 

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

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

func (*ProjectsLocationsOperationsDeleteCall) Header 

func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall 

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

func (*ProjectsLocationsOperationsGetCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall) Do 

func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "composer.projects.locations.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 (*ProjectsLocationsOperationsGetCall) Fields 

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

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

func (*ProjectsLocationsOperationsGetCall) Header 

func (c *ProjectsLocationsOperationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch 

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

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 ProjectsLocationsOperationsListCall 

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

func (*ProjectsLocationsOperationsListCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall) Do 

func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "composer.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.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 (*ProjectsLocationsOperationsListCall) Fields 

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

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

func (*ProjectsLocationsOperationsListCall) Filter 

func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header 

func (c *ProjectsLocationsOperationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch 

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

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 (*ProjectsLocationsOperationsListCall) PageSize 

func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages 

func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) 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.

type ProjectsLocationsOperationsService 

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

func NewProjectsLocationsOperationsService 

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Delete 

func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get 

func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List 

func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	Environments *ProjectsLocationsEnvironmentsService

	ImageVersions *ProjectsLocationsImageVersionsService

	Operations *ProjectsLocationsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService 

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type RecoveryConfig added in v0.104.0 

type RecoveryConfig struct {
	// ScheduledSnapshotsConfig: Optional. The configuration for scheduled snapshot
	// creation mechanism.
	ScheduledSnapshotsConfig *ScheduledSnapshotsConfig `json:"scheduledSnapshotsConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ScheduledSnapshotsConfig")
	// 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. "ScheduledSnapshotsConfig") 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:"-"`
}

RecoveryConfig: The Recovery settings of an environment.

func (RecoveryConfig) MarshalJSON added in v0.104.0 

func (s RecoveryConfig) MarshalJSON() ([]byte, error)

type SaveSnapshotRequest added in v0.104.0 

type SaveSnapshotRequest struct {
	// SnapshotLocation: Location in a Cloud Storage where the snapshot is going to
	// be stored, e.g.: "gs://my-bucket/snapshots".
	SnapshotLocation string `json:"snapshotLocation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SnapshotLocation") 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. "SnapshotLocation") 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:"-"`
}

SaveSnapshotRequest: Request to create a snapshot of a Cloud Composer environment.

func (SaveSnapshotRequest) MarshalJSON added in v0.104.0 

func (s SaveSnapshotRequest) MarshalJSON() ([]byte, error)

type SaveSnapshotResponse added in v0.98.0 

type SaveSnapshotResponse struct {
	// SnapshotPath: The fully-resolved Cloud Storage path of the created snapshot,
	// e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp".
	// This field is populated only if the snapshot creation was successful.
	SnapshotPath string `json:"snapshotPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SnapshotPath") 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. "SnapshotPath") 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:"-"`
}

SaveSnapshotResponse: Response to SaveSnapshotRequest.

func (SaveSnapshotResponse) MarshalJSON added in v0.98.0 

func (s SaveSnapshotResponse) MarshalJSON() ([]byte, error)

type ScheduledSnapshotsConfig added in v0.104.0 

type ScheduledSnapshotsConfig struct {
	// Enabled: Optional. Whether scheduled snapshots creation is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// SnapshotCreationSchedule: Optional. The cron expression representing the
	// time when snapshots creation mechanism runs. This field is subject to
	// additional validation around frequency of execution.
	SnapshotCreationSchedule string `json:"snapshotCreationSchedule,omitempty"`
	// SnapshotLocation: Optional. The Cloud Storage location for storing
	// automatically created snapshots.
	SnapshotLocation string `json:"snapshotLocation,omitempty"`
	// TimeZone: Optional. Time zone that sets the context to interpret
	// snapshot_creation_schedule.
	TimeZone string `json:"timeZone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`
}

ScheduledSnapshotsConfig: The configuration for scheduled snapshot creation mechanism.

func (ScheduledSnapshotsConfig) MarshalJSON added in v0.104.0 

func (s ScheduledSnapshotsConfig) MarshalJSON() ([]byte, error)

type SchedulerResource added in v0.61.0 

type SchedulerResource struct {
	// Count: Optional. The number of schedulers.
	Count int64 `json:"count,omitempty"`
	// Cpu: Optional. CPU request and limit for a single Airflow scheduler replica.
	Cpu float64 `json:"cpu,omitempty"`
	// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow
	// scheduler replica.
	MemoryGb float64 `json:"memoryGb,omitempty"`
	// StorageGb: Optional. Storage (GB) request and limit for a single Airflow
	// scheduler replica.
	StorageGb float64 `json:"storageGb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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:"-"`
}

SchedulerResource: Configuration for resources used by Airflow schedulers.

func (SchedulerResource) MarshalJSON added in v0.61.0 

func (s SchedulerResource) MarshalJSON() ([]byte, error)

func (*SchedulerResource) UnmarshalJSON added in v0.61.0 

func (s *SchedulerResource) UnmarshalJSON(data []byte) error

type Service 

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

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 added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SoftwareConfig 

type SoftwareConfig struct {
	// AirflowConfigOverrides: Optional. Apache Airflow configuration properties to
	// override. Property keys contain the section and property names, separated by
	// a hyphen, for example "core-dags_are_paused_at_creation". Section names must
	// not contain hyphens ("-"), opening square brackets ("["), or closing square
	// brackets ("]"). The property name must not be empty and must not contain an
	// equals sign ("=") or semicolon (";"). Section and property names must not
	// contain a period ("."). Apache Airflow configuration property names must be
	// written in snake_case (https://en.wikipedia.org/wiki/Snake_case). Property
	// values can contain any character, and can be written in any lower/upper case
	// format. Certain Apache Airflow configuration property values are blocked
	// (/composer/docs/concepts/airflow-configurations), and cannot be overridden.
	AirflowConfigOverrides map[string]string `json:"airflowConfigOverrides,omitempty"`
	// CloudDataLineageIntegration: Optional. The configuration for Cloud Data
	// Lineage integration.
	CloudDataLineageIntegration *CloudDataLineageIntegration `json:"cloudDataLineageIntegration,omitempty"`
	// EnvVariables: Optional. Additional environment variables to provide to the
	// Apache Airflow scheduler, worker, and webserver processes. Environment
	// variable names must match the regular expression `a-zA-Z_*`. They cannot
	// specify Apache Airflow software configuration overrides (they cannot match
	// the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot
	// match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT`
	// * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` *
	// `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` *
	// `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
	EnvVariables map[string]string `json:"envVariables,omitempty"`
	// ImageVersion: Optional. The version of the software running in the
	// environment. This encapsulates both the version of Cloud Composer
	// functionality and the version of Apache Airflow. It must match the regular
	// expression
	// `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9
	// ]+(\.[0-9]+(\.[0-9]+)?)?)`. When used as input, the server also checks if
	// the provided version is supported and denies the request for an unsupported
	// version. The Cloud Composer portion of the image version is a full semantic
	// version (https://semver.org), or an alias in the form of major version
	// number or `latest`. When an alias is provided, the server replaces it with
	// the current Cloud Composer version that satisfies the alias. The Apache
	// Airflow portion of the image version is a full semantic version that points
	// to one of the supported Apache Airflow versions, or an alias in the form of
	// only major or major.minor versions specified. When an alias is provided, the
	// server replaces it with the latest Apache Airflow version that satisfies the
	// alias and is supported in the given Cloud Composer version. In all cases,
	// the resolved image version is stored in the same field. See also version
	// list (/composer/docs/concepts/versioning/composer-versions) and versioning
	// overview (/composer/docs/concepts/versioning/composer-versioning-overview).
	ImageVersion string `json:"imageVersion,omitempty"`
	// PypiPackages: Optional. Custom Python Package Index (PyPI) packages to be
	// installed in the environment. Keys refer to the lowercase package name such
	// as "numpy" and values are the lowercase extras and version specifier such as
	// "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a
	// package without pinning it to a version specifier, use the empty string as
	// the value.
	PypiPackages map[string]string `json:"pypiPackages,omitempty"`
	// PythonVersion: Optional. The major version of Python used to run the Apache
	// Airflow scheduler, worker, and webserver processes. Can be set to '2' or
	// '3'. If not specified, the default is '3'. Cannot be updated. This field is
	// only supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-*.*.*. Environments in newer versions always use
	// Python major version 3.
	PythonVersion string `json:"pythonVersion,omitempty"`
	// SchedulerCount: Optional. The number of schedulers for Airflow. This field
	// is supported for Cloud Composer environments in versions
	// composer-1.*.*-airflow-2.*.*.
	SchedulerCount int64 `json:"schedulerCount,omitempty"`
	// WebServerPluginsMode: Optional. Whether or not the web server uses custom
	// plugins. If unspecified, the field defaults to `PLUGINS_ENABLED`. This field
	// is supported for Cloud Composer environments in versions
	// composer-3.*.*-airflow-*.*.* and newer.
	//
	// Possible values:
	//   "WEB_SERVER_PLUGINS_MODE_UNSPECIFIED" - Default mode.
	//   "PLUGINS_DISABLED" - Web server plugins are not supported.
	//   "PLUGINS_ENABLED" - Web server plugins are supported.
	WebServerPluginsMode string `json:"webServerPluginsMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AirflowConfigOverrides") 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. "AirflowConfigOverrides") 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:"-"`
}

SoftwareConfig: Specifies the selection and configuration of software inside the environment.

func (SoftwareConfig) MarshalJSON 

func (s SoftwareConfig) MarshalJSON() ([]byte, error)

type Status 

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:"-"`
}

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).

func (Status) MarshalJSON 

func (s Status) MarshalJSON() ([]byte, error)

type StopAirflowCommandRequest added in v0.125.0 

type StopAirflowCommandRequest struct {
	// ExecutionId: The unique ID of the command execution.
	ExecutionId string `json:"executionId,omitempty"`
	// Force: If true, the execution is terminated forcefully (SIGKILL). If false,
	// the execution is stopped gracefully, giving it time for cleanup.
	Force bool `json:"force,omitempty"`
	// Pod: The name of the pod where the command is executed.
	Pod string `json:"pod,omitempty"`
	// PodNamespace: The namespace of the pod where the command is executed.
	PodNamespace string `json:"podNamespace,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExecutionId") 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. "ExecutionId") 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:"-"`
}

StopAirflowCommandRequest: Stop Airflow Command request.

func (StopAirflowCommandRequest) MarshalJSON added in v0.125.0 

func (s StopAirflowCommandRequest) MarshalJSON() ([]byte, error)

type StopAirflowCommandResponse added in v0.125.0 

type StopAirflowCommandResponse struct {
	// IsDone: Whether the execution is still running.
	IsDone bool `json:"isDone,omitempty"`
	// Output: Output message from stopping execution request.
	Output []string `json:"output,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "IsDone") 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. "IsDone") 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:"-"`
}

StopAirflowCommandResponse: Response to StopAirflowCommandRequest.

func (StopAirflowCommandResponse) MarshalJSON added in v0.125.0 

func (s StopAirflowCommandResponse) MarshalJSON() ([]byte, error)

type StorageConfig added in v0.140.0 

type StorageConfig struct {
	// Bucket: Optional. The name of the Cloud Storage bucket used by the
	// environment. No `gs://` prefix.
	Bucket string `json:"bucket,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Bucket") 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. "Bucket") 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:"-"`
}

StorageConfig: The configuration for data storage in the environment.

func (StorageConfig) MarshalJSON added in v0.146.0 

func (s StorageConfig) MarshalJSON() ([]byte, error)

type TaskLogsRetentionConfig added in v0.156.0 

type TaskLogsRetentionConfig struct {
	// StorageMode: Optional. The mode of storage for Airflow workers task logs.
	//
	// Possible values:
	//   "TASK_LOGS_STORAGE_MODE_UNSPECIFIED" - This configuration is not specified
	// by the user.
	//   "CLOUD_LOGGING_AND_CLOUD_STORAGE" - Store task logs in Cloud Logging and
	// in the environment's Cloud Storage bucket.
	//   "CLOUD_LOGGING_ONLY" - Store task logs in Cloud Logging only.
	StorageMode string `json:"storageMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "StorageMode") 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. "StorageMode") 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:"-"`
}

TaskLogsRetentionConfig: The configuration setting for Task Logs.

func (TaskLogsRetentionConfig) MarshalJSON added in v0.156.0 

func (s TaskLogsRetentionConfig) MarshalJSON() ([]byte, error)

type TriggererResource added in v0.143.0 

type TriggererResource struct {
	// Count: Optional. The number of triggerers.
	Count int64 `json:"count,omitempty"`
	// Cpu: Optional. CPU request and limit for a single Airflow triggerer replica.
	Cpu float64 `json:"cpu,omitempty"`
	// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow
	// triggerer replica.
	MemoryGb float64 `json:"memoryGb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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:"-"`
}

TriggererResource: Configuration for resources used by Airflow triggerers.

func (TriggererResource) MarshalJSON added in v0.143.0 

func (s TriggererResource) MarshalJSON() ([]byte, error)

func (*TriggererResource) UnmarshalJSON added in v0.143.0 

func (s *TriggererResource) UnmarshalJSON(data []byte) error

type UserWorkloadsConfigMap added in v0.163.0 

type UserWorkloadsConfigMap struct {
	// Data: Optional. The "data" field of Kubernetes ConfigMap, organized in
	// key-value pairs. For details see:
	// https://kubernetes.io/docs/concepts/configuration/configmap/ Example: {
	// "example_key": "example_value", "another_key": "another_value" }
	Data map[string]string `json:"data,omitempty"`
	// Name: Identifier. The resource name of the ConfigMap, in the form:
	// "projects/{projectId}/locations/{locationId}/environments/{environmentId}/use
	// rWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Data") 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. "Data") 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:"-"`
}

UserWorkloadsConfigMap: User workloads ConfigMap used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.

func (UserWorkloadsConfigMap) MarshalJSON added in v0.163.0 

func (s UserWorkloadsConfigMap) MarshalJSON() ([]byte, error)

type UserWorkloadsSecret added in v0.163.0 

type UserWorkloadsSecret struct {
	// Data: Optional. The "data" field of Kubernetes Secret, organized in
	// key-value pairs, which can contain sensitive values such as a password, a
	// token, or a key. The values for all keys have to be base64-encoded strings.
	// For details see: https://kubernetes.io/docs/concepts/configuration/secret/
	// Example: { "example": "ZXhhbXBsZV92YWx1ZQ==", "another-example":
	// "YW5vdGhlcl9leGFtcGxlX3ZhbHVl" }
	Data map[string]string `json:"data,omitempty"`
	// Name: Identifier. The resource name of the Secret, in the form:
	// "projects/{projectId}/locations/{locationId}/environments/{environmentId}/use
	// rWorkloadsSecrets/{userWorkloadsSecretId}"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Data") 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. "Data") 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:"-"`
}

UserWorkloadsSecret: User workloads Secret used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.

func (UserWorkloadsSecret) MarshalJSON added in v0.163.0 

func (s UserWorkloadsSecret) MarshalJSON() ([]byte, error)

type WebServerConfig added in v0.37.0 

type WebServerConfig struct {
	// MachineType: Optional. Machine type on which Airflow web server is running.
	// It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
	// composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be
	// used. Value custom is returned only in response, if Airflow web server
	// parameters were manually changed to a non-standard values.
	MachineType string `json:"machineType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MachineType") 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. "MachineType") 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:"-"`
}

WebServerConfig: The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*

func (WebServerConfig) MarshalJSON added in v0.37.0 

func (s WebServerConfig) MarshalJSON() ([]byte, error)

type WebServerNetworkAccessControl added in v0.37.0 

type WebServerNetworkAccessControl struct {
	// AllowedIpRanges: A collection of allowed IP ranges with descriptions.
	AllowedIpRanges []*AllowedIpRange `json:"allowedIpRanges,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedIpRanges") 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. "AllowedIpRanges") 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:"-"`
}

WebServerNetworkAccessControl: Network-level access control policy for the Airflow web server.

func (WebServerNetworkAccessControl) MarshalJSON added in v0.37.0 

func (s WebServerNetworkAccessControl) MarshalJSON() ([]byte, error)

type WebServerResource added in v0.61.0 

type WebServerResource struct {
	// Cpu: Optional. CPU request and limit for Airflow web server.
	Cpu float64 `json:"cpu,omitempty"`
	// MemoryGb: Optional. Memory (GB) request and limit for Airflow web server.
	MemoryGb float64 `json:"memoryGb,omitempty"`
	// StorageGb: Optional. Storage (GB) request and limit for Airflow web server.
	StorageGb float64 `json:"storageGb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cpu") 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. "Cpu") 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:"-"`
}

WebServerResource: Configuration for resources used by Airflow web server.

func (WebServerResource) MarshalJSON added in v0.61.0 

func (s WebServerResource) MarshalJSON() ([]byte, error)

func (*WebServerResource) UnmarshalJSON added in v0.61.0 

func (s *WebServerResource) UnmarshalJSON(data []byte) error

type WorkerResource added in v0.61.0 

type WorkerResource struct {
	// Cpu: Optional. CPU request and limit for a single Airflow worker replica.
	Cpu float64 `json:"cpu,omitempty"`
	// MaxCount: Optional. Maximum number of workers for autoscaling.
	MaxCount int64 `json:"maxCount,omitempty"`
	// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow
	// worker replica.
	MemoryGb float64 `json:"memoryGb,omitempty"`
	// MinCount: Optional. Minimum number of workers for autoscaling.
	MinCount int64 `json:"minCount,omitempty"`
	// StorageGb: Optional. Storage (GB) request and limit for a single Airflow
	// worker replica.
	StorageGb float64 `json:"storageGb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cpu") 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. "Cpu") 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:"-"`
}

WorkerResource: Configuration for resources used by Airflow workers.

func (WorkerResource) MarshalJSON added in v0.61.0 

func (s WorkerResource) MarshalJSON() ([]byte, error)

func (*WorkerResource) UnmarshalJSON added in v0.61.0 

func (s *WorkerResource) UnmarshalJSON(data []byte) error

type WorkloadsConfig added in v0.61.0 

type WorkloadsConfig struct {
	// DagProcessor: Optional. Resources used by Airflow DAG processors. This field
	// is supported for Cloud Composer environments in versions
	// composer-3.*.*-airflow-*.*.* and newer.
	DagProcessor *DagProcessorResource `json:"dagProcessor,omitempty"`
	// Scheduler: Optional. Resources used by Airflow schedulers.
	Scheduler *SchedulerResource `json:"scheduler,omitempty"`
	// Triggerer: Optional. Resources used by Airflow triggerers.
	Triggerer *TriggererResource `json:"triggerer,omitempty"`
	// WebServer: Optional. Resources used by Airflow web server.
	WebServer *WebServerResource `json:"webServer,omitempty"`
	// Worker: Optional. Resources used by Airflow workers.
	Worker *WorkerResource `json:"worker,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DagProcessor") 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. "DagProcessor") 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:"-"`
}

WorkloadsConfig: The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.

func (WorkloadsConfig) MarshalJSON added in v0.61.0 

func (s WorkloadsConfig) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

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