Movatterモバイル変換


[0]ホーム

URL:


composer

package
v0.257.0Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:35

Details

Repository

github.com/googleapis/google-api-go-client

Links

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, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany 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 forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

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

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

typeAirflowMetadataRetentionPolicyConfigadded inv0.168.0

type AirflowMetadataRetentionPolicyConfig struct {// RetentionDays: Optional. How many days data should be retained for.RetentionDaysint64 `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.RetentionModestring `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 metadatadatabase retention.

func (AirflowMetadataRetentionPolicyConfig)MarshalJSONadded inv0.168.0

typeAllowedIpRangeadded inv0.37.0

type AllowedIpRange struct {// Description: Optional. User-provided description. It must contain at most// 300 characters.Descriptionstring `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`.Valuestring `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)MarshalJSONadded inv0.37.0

func (sAllowedIpRange) MarshalJSON() ([]byte,error)

typeCheckUpgradeRequestadded inv0.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).ImageVersionstring `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)MarshalJSONadded inv0.182.0

func (sCheckUpgradeRequest) MarshalJSON() ([]byte,error)

typeCheckUpgradeResponseadded inv0.48.0

type CheckUpgradeResponse struct {// BuildLogUri: Output only. Url for a docker build log of an upgraded image.BuildLogUristring `json:"buildLogUri,omitempty"`// ConfigConflicts: Output only. Contains information about environment// configuration that is incompatible with the new image version, except for// pypi modules conflicts.ConfigConflicts []*ConfigConflict `json:"configConflicts,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.ContainsPypiModulesConflictstring `json:"containsPypiModulesConflict,omitempty"`// ImageVersion: Composer image for which the build was happening.ImageVersionstring `json:"imageVersion,omitempty"`// PypiConflictBuildLogExtract: Output only. Extract from a docker image build// log containing information about pypi modules conflicts.PypiConflictBuildLogExtractstring `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 anupgrade check operation.

func (CheckUpgradeResponse)MarshalJSONadded inv0.48.0

func (sCheckUpgradeResponse) MarshalJSON() ([]byte,error)

typeCidrBlockadded inv0.80.0

type CidrBlock struct {// CidrBlock: CIDR block that must be specified in CIDR notation.CidrBlockstring `json:"cidrBlock,omitempty"`// DisplayName: User-defined name that identifies the CIDR block.DisplayNamestring `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)MarshalJSONadded inv0.80.0

func (sCidrBlock) MarshalJSON() ([]byte,error)

typeCloudDataLineageIntegrationadded inv0.156.0

type CloudDataLineageIntegration struct {// Enabled: Optional. Whether or not Cloud Data Lineage integration is enabled.Enabledbool `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 Lineageintegration.

func (CloudDataLineageIntegration)MarshalJSONadded inv0.156.0

func (sCloudDataLineageIntegration) MarshalJSON() ([]byte,error)

typeComposerWorkloadadded inv0.160.0

type ComposerWorkload struct {// Name: Name of a workload.Namestring `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.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty 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)MarshalJSONadded inv0.160.0

func (sComposerWorkload) MarshalJSON() ([]byte,error)

typeComposerWorkloadStatusadded inv0.160.0

type ComposerWorkloadStatus struct {// DetailedStatusMessage: Output only. Detailed message of the status.DetailedStatusMessagestring `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.Statestring `json:"state,omitempty"`// StatusMessage: Output only. Text to provide more descriptive status.StatusMessagestring `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)MarshalJSONadded inv0.160.0

func (sComposerWorkloadStatus) MarshalJSON() ([]byte,error)

typeConfigConflictadded inv0.252.0

type ConfigConflict struct {// Message: Conflict message.Messagestring `json:"message,omitempty"`// Type: Conflict type. It can be blocking or non-blocking.//// Possible values://   "CONFLICT_TYPE_UNSPECIFIED" - Conflict type is unknown.//   "BLOCKING" - Conflict is blocking, the upgrade would fail.//   "NON_BLOCKING" - Conflict is non-blocking. The upgrade would succeed, but// the environment configuration would be changed.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Message") 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. "Message") 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:"-"`}

ConfigConflict: Environment configuration conflict.

func (ConfigConflict)MarshalJSONadded inv0.252.0

func (sConfigConflict) MarshalJSON() ([]byte,error)

typeDagProcessorResourceadded inv0.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.Countint64 `json:"count,omitempty"`// Cpu: Optional. CPU request and limit for a single Airflow DAG processor// replica.Cpufloat64 `json:"cpu,omitempty"`// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow DAG// processor replica.MemoryGbfloat64 `json:"memoryGb,omitempty"`// StorageGb: Optional. Storage (GB) request and limit for a single Airflow DAG// processor replica.StorageGbfloat64 `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 DAGprocessors. This field is supported for Cloud Composer environments inversions composer-3-airflow-*.*.*-build.* and newer.

func (DagProcessorResource)MarshalJSONadded inv0.160.0

func (sDagProcessorResource) MarshalJSON() ([]byte,error)

func (*DagProcessorResource)UnmarshalJSONadded inv0.160.0

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

typeDataRetentionConfigadded inv0.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// retentionTaskLogsRetentionConfig *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 dataretention mechanism.

func (DataRetentionConfig)MarshalJSONadded inv0.156.0

func (sDataRetentionConfig) MarshalJSON() ([]byte,error)

typeDatabaseConfigadded inv0.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-*.*.*.MachineTypestring `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-*.*.*.Zonestring `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 theApache Airflow software.

func (DatabaseConfig)MarshalJSONadded inv0.37.0

func (sDatabaseConfig) MarshalJSON() ([]byte,error)

typeDatabaseFailoverRequestadded inv0.125.0

type DatabaseFailoverRequest struct {}

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

typeDatabaseFailoverResponseadded inv0.125.0

type DatabaseFailoverResponse struct {}

DatabaseFailoverResponse: Response for DatabaseFailoverRequest.

typeDateadded inv0.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.Dayint64 `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.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `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. Thetime of day and time zone are either specified elsewhere or areinsignificant. The date is relative to the Gregorian Calendar. This canrepresent 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, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp

func (Date)MarshalJSONadded inv0.37.0

func (sDate) MarshalJSON() ([]byte,error)

typeEmpty

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 definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeEncryptionConfigadded inv0.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.KmsKeyNamestring `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 environmentand its dependencies.Supported for Cloud Composer environments in versionscomposer-1.*.*-airflow-*.*.*.

func (EncryptionConfig)MarshalJSONadded inv0.39.0

func (sEncryptionConfig) MarshalJSON() ([]byte,error)

typeEnvironment

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.CreateTimestring `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.Namestring `json:"name,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `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.Statestring `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.UpdateTimestring `json:"updateTime,omitempty"`// Uuid: Output only. The UUID (Universally Unique IDentifier) associated with// this environment. This value is generated when the environment is created.Uuidstring `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 (sEnvironment) MarshalJSON() ([]byte,error)

typeEnvironmentConfig

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)).AirflowByoidUristring `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)).AirflowUristring `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.DagGcsPrefixstring `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.//   "ENVIRONMENT_SIZE_EXTRA_LARGE" - The environment size is extra large.EnvironmentSizestring `json:"environmentSize,omitempty"`// GkeCluster: Output only. The Kubernetes Engine cluster used to run this// environment.GkeClusterstring `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-*.*.*.NodeCountint64 `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.ResilienceModestring `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 (sEnvironmentConfig) MarshalJSON() ([]byte,error)

typeExecuteAirflowCommandRequestadded inv0.125.0

type ExecuteAirflowCommandRequest struct {// Command: Airflow command.Commandstring `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.Subcommandstring `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)MarshalJSONadded inv0.125.0

func (sExecuteAirflowCommandRequest) MarshalJSON() ([]byte,error)

typeExecuteAirflowCommandResponseadded inv0.125.0

type ExecuteAirflowCommandResponse struct {// Error: Error message. Empty if there was no error.Errorstring `json:"error,omitempty"`// ExecutionId: The unique ID of the command execution for polling.ExecutionIdstring `json:"executionId,omitempty"`// Pod: The name of the pod where the command is executed.Podstring `json:"pod,omitempty"`// PodNamespace: The namespace of the pod where the command is executed.PodNamespacestring `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)MarshalJSONadded inv0.125.0

func (sExecuteAirflowCommandResponse) MarshalJSON() ([]byte,error)

typeExitInfoadded inv0.125.0

type ExitInfo struct {// Error: Error message. Empty if there was no error.Errorstring `json:"error,omitempty"`// ExitCode: The exit code from the command execution.ExitCodeint64 `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)MarshalJSONadded inv0.125.0

func (sExitInfo) MarshalJSON() ([]byte,error)

typeFetchDatabasePropertiesResponseadded inv0.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.IsFailoverReplicaAvailablebool `json:"isFailoverReplicaAvailable,omitempty"`// PrimaryGceZone: The Compute Engine zone that the instance is currently// serving from.PrimaryGceZonestring `json:"primaryGceZone,omitempty"`// SecondaryGceZone: The Compute Engine zone that the failover instance is// currently serving from for a regional Cloud SQL instance.SecondaryGceZonestring `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 forFetchDatabasePropertiesRequest.

func (FetchDatabasePropertiesResponse)MarshalJSONadded inv0.125.0

func (sFetchDatabasePropertiesResponse) MarshalJSON() ([]byte,error)

typeIPAllocationPolicyadded inv0.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.ClusterIpv4CidrBlockstring `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.ClusterSecondaryRangeNamestring `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.ServicesIpv4CidrBlockstring `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.ServicesSecondaryRangeNamestring `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.UseIpAliasesbool `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 inthe GKE cluster running the Apache Airflow software.

func (IPAllocationPolicy)MarshalJSONadded inv0.22.0

func (sIPAllocationPolicy) MarshalJSON() ([]byte,error)

typeImageVersionadded inv0.2.0

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

func (sImageVersion) MarshalJSON() ([]byte,error)

typeLineadded inv0.125.0

type Line struct {// Content: Text content of the log line.Contentstring `json:"content,omitempty"`// LineNumber: Number of the line.LineNumberint64 `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)MarshalJSONadded inv0.125.0

func (sLine) MarshalJSON() ([]byte,error)

typeListEnvironmentsResponse

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.NextPageTokenstring `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 (sListEnvironmentsResponse) MarshalJSON() ([]byte,error)

typeListImageVersionsResponseadded inv0.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.NextPageTokenstring `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)MarshalJSONadded inv0.2.0

func (sListImageVersionsResponse) MarshalJSON() ([]byte,error)

typeListOperationsResponse

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections. For example, when attempting to list all resources across all// supported locations.Unreachable []string `json:"unreachable,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 (sListOperationsResponse) MarshalJSON() ([]byte,error)

typeListUserWorkloadsConfigMapsResponseadded inv0.163.0

type ListUserWorkloadsConfigMapsResponse struct {// NextPageToken: The page token used to query for the next page if one exists.NextPageTokenstring `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 agiven environment.

func (ListUserWorkloadsConfigMapsResponse)MarshalJSONadded inv0.163.0

typeListUserWorkloadsSecretsResponseadded inv0.163.0

type ListUserWorkloadsSecretsResponse struct {// NextPageToken: The page token used to query for the next page if one exists.NextPageTokenstring `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 givenenvironment.

func (ListUserWorkloadsSecretsResponse)MarshalJSONadded inv0.163.0

func (sListUserWorkloadsSecretsResponse) MarshalJSON() ([]byte,error)

typeListWorkloadsResponseadded inv0.160.0

type ListWorkloadsResponse struct {// NextPageToken: The page token used to query for the next page if one exists.NextPageTokenstring `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)MarshalJSONadded inv0.160.0

func (sListWorkloadsResponse) MarshalJSON() ([]byte,error)

typeLoadSnapshotRequestadded inv0.104.0

type LoadSnapshotRequest struct {// SkipAirflowOverridesSetting: Whether or not to skip setting Airflow// overrides when loading the environment's state.SkipAirflowOverridesSettingbool `json:"skipAirflowOverridesSetting,omitempty"`// SkipEnvironmentVariablesSetting: Whether or not to skip setting environment// variables when loading the environment's state.SkipEnvironmentVariablesSettingbool `json:"skipEnvironmentVariablesSetting,omitempty"`// SkipGcsDataCopying: Whether or not to skip copying Cloud Storage data when// loading the environment's state.SkipGcsDataCopyingbool `json:"skipGcsDataCopying,omitempty"`// SkipPypiPackagesInstallation: Whether or not to skip installing Pypi// packages when loading the environment's state.SkipPypiPackagesInstallationbool `json:"skipPypiPackagesInstallation,omitempty"`// SnapshotPath: A Cloud Storage path to a snapshot to load, e.g.:// "gs://my-bucket/snapshots/project_location_environment_timestamp".SnapshotPathstring `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. Seehttps://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 Composerenvironment.

func (LoadSnapshotRequest)MarshalJSONadded inv0.104.0

func (sLoadSnapshotRequest) MarshalJSON() ([]byte,error)

typeLoadSnapshotResponseadded inv0.98.0

type LoadSnapshotResponse struct {}

LoadSnapshotResponse: Response to LoadSnapshotRequest.

typeMaintenanceWindowadded inv0.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`.EndTimestring `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`.Recurrencestring `json:"recurrence,omitempty"`// StartTime: Required. Start time of the first recurrence of the maintenance// window.StartTimestring `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 maintenancewindow. 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 duringeach Tuesday and Wednesday.

func (MaintenanceWindow)MarshalJSONadded inv0.62.0

func (sMaintenanceWindow) MarshalJSON() ([]byte,error)

typeMasterAuthorizedNetworksConfigadded inv0.80.0

type MasterAuthorizedNetworksConfig struct {// CidrBlocks: Up to 50 external networks that could access Kubernetes master// through HTTPS.CidrBlocks []*CidrBlock `json:"cidrBlocks,omitempty"`// Enabled: Optional. Whether or not master authorized networks feature is// enabled.Enabledbool `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 masterauthorized networks feature. Enabled master authorized networks willdisallow all external traffic to access Kubernetes master through HTTPSexcept traffic from the given CIDR blocks, Google Compute Engine Public IPsand Google Prod IPs.

func (MasterAuthorizedNetworksConfig)MarshalJSONadded inv0.80.0

func (sMasterAuthorizedNetworksConfig) MarshalJSON() ([]byte,error)

typeNetworkingConfigadded inv0.101.0

type NetworkingConfig struct {// ConnectionType: Optional. Indicates the user requested specific 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.ConnectionTypestring `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 theComposer 2 environment.

func (NetworkingConfig)MarshalJSONadded inv0.101.0

func (sNetworkingConfig) MarshalJSON() ([]byte,error)

typeNodeConfig

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-*.*.*-build.* and newer.ComposerInternalIpv4CidrBlockstring `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-*.*.*-build.* and newer.ComposerNetworkAttachmentstring `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-*.*.*.DiskSizeGbint64 `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-agentEnableIpMasqAgentbool `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-*.*.*.Locationstring `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-*.*.*.MachineTypestring `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`.Networkstring `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.ServiceAccountstring `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.Subnetworkstring `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. Seehttps://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 nodesrunning the Apache Airflow software.

func (NodeConfig)MarshalJSON

func (sNodeConfig) MarshalJSON() ([]byte,error)

typeOperation

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.Donebool `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.Metadatagoogleapi.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}`.Namestring `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`.Responsegoogleapi.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 theresult of a network API call.

func (Operation)MarshalJSON

func (sOperation) MarshalJSON() ([]byte,error)

typeOperationMetadata

type OperationMetadata struct {// CreateTime: Output only. The time the operation was submitted to the server.CreateTimestring `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.EndTimestring `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).//   "MIGRATE" - Migrates resource to a new major version.OperationTypestring `json:"operationType,omitempty"`// Resource: Output only. The resource being operated on, as a relative// resource name ( /apis/design/resource_names#relative_resource_name).Resourcestring `json:"resource,omitempty"`// ResourceUuid: Output only. The UUID of the resource being operated on.ResourceUuidstring `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.Statestring `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 (sOperationMetadata) MarshalJSON() ([]byte,error)

typePollAirflowCommandRequestadded inv0.125.0

type PollAirflowCommandRequest struct {// ExecutionId: The unique ID of the command execution.ExecutionIdstring `json:"executionId,omitempty"`// NextLineNumber: Line number from which new logs should be fetched.NextLineNumberint64 `json:"nextLineNumber,omitempty"`// Pod: The name of the pod where the command is executed.Podstring `json:"pod,omitempty"`// PodNamespace: The namespace of the pod where the command is executed.PodNamespacestring `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)MarshalJSONadded inv0.125.0

func (sPollAirflowCommandRequest) MarshalJSON() ([]byte,error)

typePollAirflowCommandResponseadded inv0.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.OutputEndbool `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)MarshalJSONadded inv0.125.0

func (sPollAirflowCommandResponse) MarshalJSON() ([]byte,error)

typePrivateClusterConfigadded inv0.22.0

type PrivateClusterConfig struct {// EnablePrivateEndpoint: Optional. If `true`, access to the public endpoint of// the GKE cluster is denied.EnablePrivateEndpointbool `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.MasterIpv4CidrBlockstring `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.MasterIpv4ReservedRangestring `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 aCloud Composer environment.

func (PrivateClusterConfig)MarshalJSONadded inv0.22.0

func (sPrivateClusterConfig) MarshalJSON() ([]byte,error)

typePrivateEnvironmentConfigadded inv0.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.CloudComposerConnectionSubnetworkstring `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.CloudComposerNetworkIpv4CidrBlockstring `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.CloudComposerNetworkIpv4ReservedRangestring `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`.CloudSqlIpv4CidrBlockstring `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-*.*.*-build.* and// newer.EnablePrivateBuildsOnlybool `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-*.*.*.EnablePrivateEnvironmentbool `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`.EnablePrivatelyUsedPublicIpsbool `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-*.*.*.WebServerIpv4CidrBlockstring `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-*.*.*.WebServerIpv4ReservedRangestring `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. Seehttps://pkg.go.dev/google.golang.org/api#hdr-NullFields for// more details.NullFields []string `json:"-"`}

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

func (PrivateEnvironmentConfig)MarshalJSONadded inv0.22.0

func (sPrivateEnvironmentConfig) MarshalJSON() ([]byte,error)

typeProjectsLocationsEnvironmentsCheckUpgradeCalladded inv0.182.0

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

func (*ProjectsLocationsEnvironmentsCheckUpgradeCall)Contextadded inv0.182.0

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

func (*ProjectsLocationsEnvironmentsCheckUpgradeCall)Doadded inv0.182.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsCheckUpgradeCall)Fieldsadded inv0.182.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsCheckUpgradeCall)Headeradded inv0.182.0

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

typeProjectsLocationsEnvironmentsCreateCall

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

func (*ProjectsLocationsEnvironmentsCreateCall)Context

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

func (*ProjectsLocationsEnvironmentsCreateCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsCreateCall)Header

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

typeProjectsLocationsEnvironmentsDatabaseFailoverCalladded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsDatabaseFailoverCall)Contextadded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsDatabaseFailoverCall)Doadded inv0.125.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsDatabaseFailoverCall)Fieldsadded inv0.125.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsDatabaseFailoverCall)Headeradded inv0.125.0

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

typeProjectsLocationsEnvironmentsDeleteCall

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

func (*ProjectsLocationsEnvironmentsDeleteCall)Context

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

func (*ProjectsLocationsEnvironmentsDeleteCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsDeleteCall)Header

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

typeProjectsLocationsEnvironmentsExecuteAirflowCommandCalladded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall)Contextadded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall)Doadded inv0.125.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall)Fieldsadded inv0.125.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsExecuteAirflowCommandCall)Headeradded inv0.125.0

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

typeProjectsLocationsEnvironmentsFetchDatabasePropertiesCalladded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall)Contextadded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall)Doadded inv0.125.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall)Fieldsadded inv0.125.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall)Headeradded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall)IfNoneMatchadded inv0.125.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsEnvironmentsGetCall

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

func (*ProjectsLocationsEnvironmentsGetCall)Context

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

func (*ProjectsLocationsEnvironmentsGetCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsGetCall)Header

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

func (*ProjectsLocationsEnvironmentsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsEnvironmentsListCall

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

func (*ProjectsLocationsEnvironmentsListCall)Context

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

func (*ProjectsLocationsEnvironmentsListCall)Do

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsListCall)Header

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

func (*ProjectsLocationsEnvironmentsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsEnvironmentsListCall)PageSize

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

func (*ProjectsLocationsEnvironmentsListCall)PageToken

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

func (*ProjectsLocationsEnvironmentsListCall)Pages

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.

typeProjectsLocationsEnvironmentsLoadSnapshotCalladded inv0.104.0

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

func (*ProjectsLocationsEnvironmentsLoadSnapshotCall)Contextadded inv0.104.0

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

func (*ProjectsLocationsEnvironmentsLoadSnapshotCall)Doadded inv0.104.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsLoadSnapshotCall)Fieldsadded inv0.104.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsLoadSnapshotCall)Headeradded inv0.104.0

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

typeProjectsLocationsEnvironmentsPatchCall

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

func (*ProjectsLocationsEnvironmentsPatchCall)Context

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

func (*ProjectsLocationsEnvironmentsPatchCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsPatchCall)Header

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

func (*ProjectsLocationsEnvironmentsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Acomma-separated list of paths, relative to `Environment`, of fields toupdate. For example, to set the version of scikit-learn to install in theenvironment 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 environmentwould specify the scikit-learn version as follows: { "config":{"softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Notethat in the above example, any existing PyPI packages other thanscikit-learn and numpy will be unaffected. Only one update type may beincluded in a single request's `updateMask`. For example, one cannot updateboth the PyPI packages and labels in the same request. However, it ispossible to update multiple members of a map field simultaneously in thesame request. For example, to set the labels "label1" and "label2" whileclearing "label3" (assuming it already exists), one can provide the paths"labels.label1", "labels.label2", and "labels.label3" and populate the patchenvironment as follows: { "labels":{ "label1":"new-label1-value""label2":"new-label2-value" } } Note that in the above example, any existinglabels that are not included in the `updateMask` will be unaffected. It isalso possible to replace an entire map field by providing the map field'spath in the `updateMask`. The new value of the field will be that which isprovided in the patch environment. For example, to delete all pre-existinguser-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 PyPIpackages. If a replacement package map is not included in `environment`, allcustom PyPI packages are cleared. It is an error to provide both this maskand a mask specifying an individual package. *`config.softwareConfig.pypiPackages.`packagename * Update the custom PyPIpackage *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 provideboth a mask of this form and the `config.softwareConfig.pypiPackages` mask.* `labels` * Replace all environment labels. If a replacement labels map isnot included in `environment`, all labels are cleared. It is an error toprovide both this mask and a mask specifying one or more individual labels.* `labels.`labelName * Set the label named *labelName*, while preservingother labels. To delete the label, include it in `updateMask` and omit itsmapping in `environment.labels`. It is an error to provide both a mask ofthis form and the `labels` mask. * `config.nodeCount` * Horizontally scalethe number of nodes in the environment. An integer greater than or equal to3 must be provided in the `config.nodeCount` field. Supported for CloudComposer environments in versions composer-1.*.*-airflow-*.*.*. *`config.webServerNetworkAccessControl` * Replace the environment's current`WebServerNetworkAccessControl`. *`config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflowconfig overrides. If a replacement config overrides map is not included in`environment`, all config overrides are cleared. It is an error to provideboth this mask and a mask specifying one or more individual configoverrides. * `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 errorto provide both a mask of this form and the`config.softwareConfig.airflowConfigOverrides` mask. *`config.softwareConfig.envVariables` * Replace all environment variables. Ifa replacement environment variable map is not included in `environment`, allcustom environment variables are cleared. *`config.softwareConfig.schedulerCount` * Horizontally scale the number ofschedulers in Airflow. A positive integer not greater than the number ofnodes must be provided in the `config.softwareConfig.schedulerCount` field.Supported for Cloud Composer environments in versionscomposer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * CloudSQL 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 versionscomposer-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 versionscomposer-1.*.*-airflow-*.*.*.

typeProjectsLocationsEnvironmentsPollAirflowCommandCalladded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsPollAirflowCommandCall)Contextadded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsPollAirflowCommandCall)Doadded inv0.125.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsPollAirflowCommandCall)Fieldsadded inv0.125.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsPollAirflowCommandCall)Headeradded inv0.125.0

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

typeProjectsLocationsEnvironmentsRestartWebServerCalladded inv0.234.0

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

func (*ProjectsLocationsEnvironmentsRestartWebServerCall)Contextadded inv0.234.0

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

func (*ProjectsLocationsEnvironmentsRestartWebServerCall)Doadded inv0.234.0

Do executes the "composer.projects.locations.environments.restartWebServer" 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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsRestartWebServerCall)Fieldsadded inv0.234.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsRestartWebServerCall)Headeradded inv0.234.0

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

typeProjectsLocationsEnvironmentsSaveSnapshotCalladded inv0.104.0

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

func (*ProjectsLocationsEnvironmentsSaveSnapshotCall)Contextadded inv0.104.0

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

func (*ProjectsLocationsEnvironmentsSaveSnapshotCall)Doadded inv0.104.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsSaveSnapshotCall)Fieldsadded inv0.104.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsSaveSnapshotCall)Headeradded inv0.104.0

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

typeProjectsLocationsEnvironmentsService

type ProjectsLocationsEnvironmentsService struct {UserWorkloadsConfigMaps *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsServiceUserWorkloadsSecrets *ProjectsLocationsEnvironmentsUserWorkloadsSecretsServiceWorkloads *ProjectsLocationsEnvironmentsWorkloadsService// contains filtered or unexported fields}

func (*ProjectsLocationsEnvironmentsService)CheckUpgradeadded inv0.182.0

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, inthe form:"projects/{projectId}/locations/{locationId}/environments/{environmentId}".

func (*ProjectsLocationsEnvironmentsService)Create

Create: Create a new environment.

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

func (*ProjectsLocationsEnvironmentsService)DatabaseFailoveradded inv0.125.0

DatabaseFailover: Triggers database failover (only for highly resilientenvironments).

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

func (*ProjectsLocationsEnvironmentsService)Delete

Delete: Delete an environment.

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

func (*ProjectsLocationsEnvironmentsService)ExecuteAirflowCommandadded inv0.125.0

ExecuteAirflowCommand: Executes Airflow CLI command.

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

func (*ProjectsLocationsEnvironmentsService)FetchDatabasePropertiesadded inv0.125.0

FetchDatabaseProperties: Fetches database properties.

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

func (*ProjectsLocationsEnvironmentsService)Get

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

List: List environments.

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

func (*ProjectsLocationsEnvironmentsService)LoadSnapshotadded inv0.104.0

LoadSnapshot: Loads a snapshot of a Cloud Composer environment. As a resultof this operation, a snapshot of environment's specified inLoadSnapshotRequest 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

Patch: Update an environment.

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

func (*ProjectsLocationsEnvironmentsService)PollAirflowCommandadded inv0.125.0

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)RestartWebServeradded inv0.234.0

RestartWebServer: Restart Airflow web server.

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

func (*ProjectsLocationsEnvironmentsService)SaveSnapshotadded inv0.104.0

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

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

func (*ProjectsLocationsEnvironmentsService)StopAirflowCommandadded inv0.125.0

StopAirflowCommand: Stops Airflow CLI command execution.

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

typeProjectsLocationsEnvironmentsStopAirflowCommandCalladded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsStopAirflowCommandCall)Contextadded inv0.125.0

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

func (*ProjectsLocationsEnvironmentsStopAirflowCommandCall)Doadded inv0.125.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsStopAirflowCommandCall)Fieldsadded inv0.125.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsStopAirflowCommandCall)Headeradded inv0.125.0

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

typeProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall)Doadded inv0.163.0

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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsCreateCall)Headeradded inv0.163.0

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

typeProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall)Doadded inv0.163.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsDeleteCall)Headeradded inv0.163.0

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

typeProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall)Doadded inv0.163.0

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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall)Headeradded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsGetCall)IfNoneMatchadded inv0.163.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)Doadded inv0.163.0

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 responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)Headeradded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)IfNoneMatchadded inv0.163.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)PageSizeadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)PageTokenadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListCall)Pagesadded inv0.163.0

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.

typeProjectsLocationsEnvironmentsUserWorkloadsConfigMapsServiceadded inv0.163.0

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

funcNewProjectsLocationsEnvironmentsUserWorkloadsConfigMapsServiceadded inv0.163.0

func NewProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService(s *Service) *ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService)Createadded inv0.163.0

Create: Creates a user workloads ConfigMap. This method is supported forCloud Composer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService)Deleteadded inv0.163.0

Delete: Deletes a user workloads ConfigMap. This method is supported forCloud Composer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService)Getadded inv0.163.0

Get: Gets an existing user workloads ConfigMap. This method is supported forCloud Composer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService)Listadded inv0.163.0

List: Lists user workloads ConfigMaps. This method is supported for CloudComposer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsService)Updateadded inv0.163.0

Update: Updates a user workloads ConfigMap. This method is supported forCloud Composer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

typeProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall)Doadded inv0.163.0

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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdateCall)Headeradded inv0.163.0

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

typeProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall)Doadded inv0.163.0

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsCreateCall)Headeradded inv0.163.0

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

typeProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall)Doadded inv0.163.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsDeleteCall)Headeradded inv0.163.0

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

typeProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall)Doadded inv0.163.0

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall)Headeradded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsGetCall)IfNoneMatchadded inv0.163.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsEnvironmentsUserWorkloadsSecretsListCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)Doadded inv0.163.0

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 responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)Headeradded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)IfNoneMatchadded inv0.163.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)PageSizeadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)PageTokenadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsListCall)Pagesadded inv0.163.0

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.

typeProjectsLocationsEnvironmentsUserWorkloadsSecretsServiceadded inv0.163.0

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

funcNewProjectsLocationsEnvironmentsUserWorkloadsSecretsServiceadded inv0.163.0

func NewProjectsLocationsEnvironmentsUserWorkloadsSecretsService(s *Service) *ProjectsLocationsEnvironmentsUserWorkloadsSecretsService

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService)Createadded inv0.163.0

Create: Creates a user workloads Secret. This method is supported for CloudComposer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService)Deleteadded inv0.163.0

Delete: Deletes a user workloads Secret. This method is supported for CloudComposer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService)Getadded inv0.163.0

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

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService)Listadded inv0.163.0

List: Lists user workloads Secrets. This method is supported for CloudComposer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsService)Updateadded inv0.163.0

Update: Updates a user workloads Secret. This method is supported for CloudComposer environments in versions composer-3-airflow-*.*.*-build.* andnewer.

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

typeProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCalladded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall)Contextadded inv0.163.0

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

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall)Doadded inv0.163.0

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall)Fieldsadded inv0.163.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsUserWorkloadsSecretsUpdateCall)Headeradded inv0.163.0

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

typeProjectsLocationsEnvironmentsWorkloadsListCalladded inv0.160.0

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)Contextadded inv0.160.0

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)Doadded inv0.160.0

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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)Fieldsadded inv0.160.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)Filteradded inv0.160.0

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)Headeradded inv0.160.0

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)IfNoneMatchadded inv0.160.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)PageSizeadded inv0.160.0

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)PageTokenadded inv0.160.0

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

func (*ProjectsLocationsEnvironmentsWorkloadsListCall)Pagesadded inv0.160.0

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.

typeProjectsLocationsEnvironmentsWorkloadsServiceadded inv0.160.0

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

funcNewProjectsLocationsEnvironmentsWorkloadsServiceadded inv0.160.0

func NewProjectsLocationsEnvironmentsWorkloadsService(s *Service) *ProjectsLocationsEnvironmentsWorkloadsService

func (*ProjectsLocationsEnvironmentsWorkloadsService)Listadded inv0.160.0

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

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

typeProjectsLocationsImageVersionsListCalladded inv0.2.0

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

func (*ProjectsLocationsImageVersionsListCall)Contextadded inv0.2.0

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

func (*ProjectsLocationsImageVersionsListCall)Doadded inv0.2.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsImageVersionsListCall)Fieldsadded inv0.2.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsImageVersionsListCall)Headeradded inv0.2.0

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

func (*ProjectsLocationsImageVersionsListCall)IfNoneMatchadded inv0.2.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsImageVersionsListCall)IncludePastReleasesadded inv0.37.0

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

func (*ProjectsLocationsImageVersionsListCall)PageSizeadded inv0.2.0

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

func (*ProjectsLocationsImageVersionsListCall)PageTokenadded inv0.2.0

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

func (*ProjectsLocationsImageVersionsListCall)Pagesadded inv0.2.0

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.

typeProjectsLocationsImageVersionsServiceadded inv0.2.0

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

funcNewProjectsLocationsImageVersionsServiceadded inv0.2.0

func NewProjectsLocationsImageVersionsService(s *Service) *ProjectsLocationsImageVersionsService

func (*ProjectsLocationsImageVersionsService)Listadded inv0.2.0

List: List ImageVersions for provided location.

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

typeProjectsLocationsOperationsDeleteCall

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

func (*ProjectsLocationsOperationsDeleteCall)Context

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

func (*ProjectsLocationsOperationsDeleteCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsDeleteCall)Header

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

typeProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall)Context

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

func (*ProjectsLocationsOperationsGetCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsGetCall)Header

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

func (*ProjectsLocationsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall)Context

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

func (*ProjectsLocationsOperationsListCall)Do

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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsOperationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsListCall)Filter

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

func (*ProjectsLocationsOperationsListCall)Header

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

func (*ProjectsLocationsOperationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall)PageSize

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

func (*ProjectsLocationsOperationsListCall)PageToken

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

func (*ProjectsLocationsOperationsListCall)Pages

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.

func (*ProjectsLocationsOperationsListCall)ReturnPartialSuccessadded inv0.252.0

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in theListOperationsResponse.unreachable field. This can only be `true` whenreading across collections. For example, when `parent` is set to"projects/example/locations/-". This field is not supported by default andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsLocationsOperationsService

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

func (*ProjectsLocationsOperationsService)Delete

Delete: Deletes a long-running operation. This method indicates that theclient is no longer interested in the operation result. It does not cancelthe 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

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

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService)List

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

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

typeProjectsLocationsService

type ProjectsLocationsService struct {Environments *ProjectsLocationsEnvironmentsServiceImageVersions *ProjectsLocationsImageVersionsServiceOperations *ProjectsLocationsOperationsService// contains filtered or unexported fields}

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

typeProjectsService

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

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeRecoveryConfigadded inv0.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)MarshalJSONadded inv0.104.0

func (sRecoveryConfig) MarshalJSON() ([]byte,error)

typeRestartWebServerRequestadded inv0.234.0

type RestartWebServerRequest struct {}

RestartWebServerRequest: Restart Airflow web server.

typeSaveSnapshotRequestadded inv0.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".SnapshotLocationstring `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 Composerenvironment.

func (SaveSnapshotRequest)MarshalJSONadded inv0.104.0

func (sSaveSnapshotRequest) MarshalJSON() ([]byte,error)

typeSaveSnapshotResponseadded inv0.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.SnapshotPathstring `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)MarshalJSONadded inv0.98.0

func (sSaveSnapshotResponse) MarshalJSON() ([]byte,error)

typeScheduledSnapshotsConfigadded inv0.104.0

type ScheduledSnapshotsConfig struct {// Enabled: Optional. Whether scheduled snapshots creation is enabled.Enabledbool `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.SnapshotCreationSchedulestring `json:"snapshotCreationSchedule,omitempty"`// SnapshotLocation: Optional. The Cloud Storage location for storing// automatically created snapshots.SnapshotLocationstring `json:"snapshotLocation,omitempty"`// TimeZone: Optional. Time zone that sets the context to interpret// snapshot_creation_schedule.TimeZonestring `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 creationmechanism.

func (ScheduledSnapshotsConfig)MarshalJSONadded inv0.104.0

func (sScheduledSnapshotsConfig) MarshalJSON() ([]byte,error)

typeSchedulerResourceadded inv0.61.0

type SchedulerResource struct {// Count: Optional. The number of schedulers.Countint64 `json:"count,omitempty"`// Cpu: Optional. CPU request and limit for a single Airflow scheduler replica.Cpufloat64 `json:"cpu,omitempty"`// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow// scheduler replica.MemoryGbfloat64 `json:"memoryGb,omitempty"`// StorageGb: Optional. Storage (GB) request and limit for a single Airflow// scheduler replica.StorageGbfloat64 `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)MarshalJSONadded inv0.61.0

func (sSchedulerResource) MarshalJSON() ([]byte,error)

func (*SchedulerResource)UnmarshalJSONadded inv0.61.0

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

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewServiceadded inv0.3.0

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

NewService creates a new Service.

typeSoftwareConfig

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).ImageVersionstring `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.PythonVersionstring `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.*.*.SchedulerCountint64 `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-*.*.*-build.* 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.WebServerPluginsModestring `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 insidethe environment.

func (SoftwareConfig)MarshalJSON

func (sSoftwareConfig) MarshalJSON() ([]byte,error)

typeStatus

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `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 fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSON

func (sStatus) MarshalJSON() ([]byte,error)

typeStopAirflowCommandRequestadded inv0.125.0

type StopAirflowCommandRequest struct {// ExecutionId: The unique ID of the command execution.ExecutionIdstring `json:"executionId,omitempty"`// Force: If true, the execution is terminated forcefully (SIGKILL). If false,// the execution is stopped gracefully, giving it time for cleanup.Forcebool `json:"force,omitempty"`// Pod: The name of the pod where the command is executed.Podstring `json:"pod,omitempty"`// PodNamespace: The namespace of the pod where the command is executed.PodNamespacestring `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)MarshalJSONadded inv0.125.0

func (sStopAirflowCommandRequest) MarshalJSON() ([]byte,error)

typeStopAirflowCommandResponseadded inv0.125.0

type StopAirflowCommandResponse struct {// IsDone: Whether the execution is still running.IsDonebool `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)MarshalJSONadded inv0.125.0

func (sStopAirflowCommandResponse) MarshalJSON() ([]byte,error)

typeStorageConfigadded inv0.140.0

type StorageConfig struct {// Bucket: Optional. The name of the Cloud Storage bucket used by the// environment. No `gs://` prefix.Bucketstring `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)MarshalJSONadded inv0.146.0

func (sStorageConfig) MarshalJSON() ([]byte,error)

typeTaskLogsRetentionConfigadded inv0.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.StorageModestring `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)MarshalJSONadded inv0.156.0

func (sTaskLogsRetentionConfig) MarshalJSON() ([]byte,error)

typeTriggererResourceadded inv0.143.0

type TriggererResource struct {// Count: Optional. The number of triggerers.Countint64 `json:"count,omitempty"`// Cpu: Optional. CPU request and limit for a single Airflow triggerer replica.Cpufloat64 `json:"cpu,omitempty"`// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow// triggerer replica.MemoryGbfloat64 `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)MarshalJSONadded inv0.143.0

func (sTriggererResource) MarshalJSON() ([]byte,error)

func (*TriggererResource)UnmarshalJSONadded inv0.143.0

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

typeUserWorkloadsConfigMapadded inv0.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}"Namestring `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 thatrun with Kubernetes executor or KubernetesPodOperator.

func (UserWorkloadsConfigMap)MarshalJSONadded inv0.163.0

func (sUserWorkloadsConfigMap) MarshalJSON() ([]byte,error)

typeUserWorkloadsSecretadded inv0.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}"Namestring `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 runwith Kubernetes executor or KubernetesPodOperator.

func (UserWorkloadsSecret)MarshalJSONadded inv0.163.0

func (sUserWorkloadsSecret) MarshalJSON() ([]byte,error)

typeWebServerConfigadded inv0.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.MachineTypestring `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 AppEngine instance. Supported for Cloud Composer environments in versionscomposer-1.*.*-airflow-*.*.*

func (WebServerConfig)MarshalJSONadded inv0.37.0

func (sWebServerConfig) MarshalJSON() ([]byte,error)

typeWebServerNetworkAccessControladded inv0.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 theAirflow web server.

func (WebServerNetworkAccessControl)MarshalJSONadded inv0.37.0

func (sWebServerNetworkAccessControl) MarshalJSON() ([]byte,error)

typeWebServerResourceadded inv0.61.0

type WebServerResource struct {// Cpu: Optional. CPU request and limit for Airflow web server.Cpufloat64 `json:"cpu,omitempty"`// MemoryGb: Optional. Memory (GB) request and limit for Airflow web server.MemoryGbfloat64 `json:"memoryGb,omitempty"`// StorageGb: Optional. Storage (GB) request and limit for Airflow web server.StorageGbfloat64 `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)MarshalJSONadded inv0.61.0

func (sWebServerResource) MarshalJSON() ([]byte,error)

func (*WebServerResource)UnmarshalJSONadded inv0.61.0

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

typeWorkerResourceadded inv0.61.0

type WorkerResource struct {// Cpu: Optional. CPU request and limit for a single Airflow worker replica.Cpufloat64 `json:"cpu,omitempty"`// MaxCount: Optional. Maximum number of workers for autoscaling.MaxCountint64 `json:"maxCount,omitempty"`// MemoryGb: Optional. Memory (GB) request and limit for a single Airflow// worker replica.MemoryGbfloat64 `json:"memoryGb,omitempty"`// MinCount: Optional. Minimum number of workers for autoscaling.MinCountint64 `json:"minCount,omitempty"`// StorageGb: Optional. Storage (GB) request and limit for a single Airflow// worker replica.StorageGbfloat64 `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)MarshalJSONadded inv0.61.0

func (sWorkerResource) MarshalJSON() ([]byte,error)

func (*WorkerResource)UnmarshalJSONadded inv0.61.0

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

typeWorkloadsConfigadded inv0.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-*.*.*-build.* 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 clusterassociated with the Cloud Composer environment. Supported for Cloud Composerenvironments in versions composer-2.*.*-airflow-*.*.* and newer.

func (WorkloadsConfig)MarshalJSONadded inv0.61.0

func (sWorkloadsConfig) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

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

[8]ページ先頭

©2009-2025 Movatter.jp