Documentation ¶
Overview ¶
Package composer provides access to the Cloud Composer API.
For product documentation, see: https://cloud.google.com/composer/
Creating a client ¶
Usage example:
import "google.golang.org/api/composer/v1beta1" ... ctx := context.Background() composerService, err := composer.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
composerService, err := composer.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) composerService, err := composer.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type AllowedIpRange
- type CheckUpgradeRequest
- type CheckUpgradeResponse
- type CidrBlock
- type DatabaseConfig
- type Date
- type Empty
- type EncryptionConfig
- type Environment
- type EnvironmentConfig
- type IPAllocationPolicy
- type ImageVersion
- type ListEnvironmentsResponse
- type ListImageVersionsResponse
- type ListOperationsResponse
- type LoadSnapshotResponse
- type MaintenanceWindow
- type MasterAuthorizedNetworksConfig
- type NodeConfig
- type Operation
- type OperationMetadata
- type PrivateClusterConfig
- type PrivateEnvironmentConfig
- type ProjectsLocationsEnvironmentsCheckUpgradeCall
- func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsCheckUpgradeCall
- func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsCheckUpgradeCall
- func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Header() http.Header
- type ProjectsLocationsEnvironmentsCreateCall
- func (c *ProjectsLocationsEnvironmentsCreateCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsCreateCall
- func (c *ProjectsLocationsEnvironmentsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsEnvironmentsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsCreateCall
- func (c *ProjectsLocationsEnvironmentsCreateCall) Header() http.Header
- type ProjectsLocationsEnvironmentsDeleteCall
- func (c *ProjectsLocationsEnvironmentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDeleteCall
- func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDeleteCall
- func (c *ProjectsLocationsEnvironmentsDeleteCall) Header() http.Header
- type ProjectsLocationsEnvironmentsGetCall
- func (c *ProjectsLocationsEnvironmentsGetCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsGetCall
- func (c *ProjectsLocationsEnvironmentsGetCall) Do(opts ...googleapi.CallOption) (*Environment, error)
- func (c *ProjectsLocationsEnvironmentsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsGetCall
- func (c *ProjectsLocationsEnvironmentsGetCall) Header() http.Header
- func (c *ProjectsLocationsEnvironmentsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsEnvironmentsGetCall
- type ProjectsLocationsEnvironmentsListCall
- func (c *ProjectsLocationsEnvironmentsListCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsListCall
- func (c *ProjectsLocationsEnvironmentsListCall) Do(opts ...googleapi.CallOption) (*ListEnvironmentsResponse, error)
- func (c *ProjectsLocationsEnvironmentsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsListCall
- func (c *ProjectsLocationsEnvironmentsListCall) Header() http.Header
- func (c *ProjectsLocationsEnvironmentsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsEnvironmentsListCall
- func (c *ProjectsLocationsEnvironmentsListCall) PageSize(pageSize int64) *ProjectsLocationsEnvironmentsListCall
- func (c *ProjectsLocationsEnvironmentsListCall) PageToken(pageToken string) *ProjectsLocationsEnvironmentsListCall
- func (c *ProjectsLocationsEnvironmentsListCall) Pages(ctx context.Context, f func(*ListEnvironmentsResponse) error) error
- type ProjectsLocationsEnvironmentsPatchCall
- func (c *ProjectsLocationsEnvironmentsPatchCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsPatchCall
- func (c *ProjectsLocationsEnvironmentsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsEnvironmentsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsPatchCall
- func (c *ProjectsLocationsEnvironmentsPatchCall) Header() http.Header
- func (c *ProjectsLocationsEnvironmentsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsEnvironmentsPatchCall
- type ProjectsLocationsEnvironmentsRestartWebServerCall
- func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsRestartWebServerCall
- func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsRestartWebServerCall
- func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Header() http.Header
- type ProjectsLocationsEnvironmentsService
- func (r *ProjectsLocationsEnvironmentsService) CheckUpgrade(environment string, checkupgraderequest *CheckUpgradeRequest) *ProjectsLocationsEnvironmentsCheckUpgradeCall
- func (r *ProjectsLocationsEnvironmentsService) Create(parent string, environment *Environment) *ProjectsLocationsEnvironmentsCreateCall
- func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall
- func (r *ProjectsLocationsEnvironmentsService) Get(name string) *ProjectsLocationsEnvironmentsGetCall
- func (r *ProjectsLocationsEnvironmentsService) List(parent string) *ProjectsLocationsEnvironmentsListCall
- func (r *ProjectsLocationsEnvironmentsService) Patch(name string, environment *Environment) *ProjectsLocationsEnvironmentsPatchCall
- func (r *ProjectsLocationsEnvironmentsService) RestartWebServer(name string, restartwebserverrequest *RestartWebServerRequest) *ProjectsLocationsEnvironmentsRestartWebServerCall
- type ProjectsLocationsImageVersionsListCall
- func (c *ProjectsLocationsImageVersionsListCall) Context(ctx context.Context) *ProjectsLocationsImageVersionsListCall
- func (c *ProjectsLocationsImageVersionsListCall) Do(opts ...googleapi.CallOption) (*ListImageVersionsResponse, error)
- func (c *ProjectsLocationsImageVersionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsImageVersionsListCall
- func (c *ProjectsLocationsImageVersionsListCall) Header() http.Header
- func (c *ProjectsLocationsImageVersionsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsImageVersionsListCall
- func (c *ProjectsLocationsImageVersionsListCall) IncludePastReleases(includePastReleases bool) *ProjectsLocationsImageVersionsListCall
- func (c *ProjectsLocationsImageVersionsListCall) PageSize(pageSize int64) *ProjectsLocationsImageVersionsListCall
- func (c *ProjectsLocationsImageVersionsListCall) PageToken(pageToken string) *ProjectsLocationsImageVersionsListCall
- func (c *ProjectsLocationsImageVersionsListCall) Pages(ctx context.Context, f func(*ListImageVersionsResponse) error) error
- type ProjectsLocationsImageVersionsService
- type ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
- type ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type ProjectsLocationsOperationsService
- func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
- func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
- func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
- type ProjectsLocationsService
- type ProjectsService
- type RestartWebServerRequest
- type SaveSnapshotResponse
- type SchedulerResource
- type Service
- type SoftwareConfig
- type Status
- type WebServerConfig
- type WebServerNetworkAccessControl
- type WebServerResource
- type WorkerResource
- type WorkloadsConfig
Constants ¶
const ( // See, edit, configure, and delete your Google Cloud data and see the // email address for your Google Account. CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AllowedIpRange ¶ added in v0.18.0
type AllowedIpRange struct { // Description: Optional. User-provided description. It must contain at // most 300 characters. Description string `json:"description,omitempty"` // Value: IP address or range, defined using CIDR notation, of requests // that this rule applies to. Examples: `192.168.1.1` or // `192.168.0.0/16` or `2001:db8::/32` or // `2001:0db8:0000:0042:0000:8a2e:0370:7334`. IP range prefixes should // be properly truncated. For example, `1.2.3.4/24` should be truncated // to `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` should be // truncated to `2001:db8::/32`. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AllowedIpRange: Allowed IP range with user-provided description.
func (*AllowedIpRange) MarshalJSON ¶ added in v0.18.0
func (s *AllowedIpRange) MarshalJSON() ([]byte, error)
type CheckUpgradeRequest ¶ added in v0.49.0
type CheckUpgradeRequest struct { // ImageVersion: 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)-airflo // w-([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 and minor versions specified. When an alias is provided, the // server replaces it with the latest Apache Airflow version that // satisfies the alias and is supported in the given Cloud Composer // version. In all cases, the resolved image version is stored in the // same field. See also version list // (/composer/docs/concepts/versioning/composer-versions) and versioning // overview // (/composer/docs/concepts/versioning/composer-versioning-overview). ImageVersion string `json:"imageVersion,omitempty"` // ForceSendFields is a list of field names (e.g. "ImageVersion") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CheckUpgradeRequest: Request to check whether image upgrade will succeed.
func (*CheckUpgradeRequest) MarshalJSON ¶ added in v0.49.0
func (s *CheckUpgradeRequest) MarshalJSON() ([]byte, error)
type CheckUpgradeResponse ¶ added in v0.49.0
type CheckUpgradeResponse struct { // BuildLogUri: Output only. Url for a docker build log of an upgraded // image. BuildLogUri string `json:"buildLogUri,omitempty"` // ContainsPypiModulesConflict: Output only. Whether build has succeeded // or failed on modules conflicts. // // Possible values: // "CONFLICT_RESULT_UNSPECIFIED" - It is unknown whether build had // conflicts or not. // "CONFLICT" - There were python packages conflicts. // "NO_CONFLICT" - There were no python packages conflicts. ContainsPypiModulesConflict string `json:"containsPypiModulesConflict,omitempty"` // ImageVersion: Composer image for which the build was happening. ImageVersion string `json:"imageVersion,omitempty"` // PypiConflictBuildLogExtract: Output only. Extract from a docker image // build log containing information about pypi modules conflicts. PypiConflictBuildLogExtract string `json:"pypiConflictBuildLogExtract,omitempty"` // PypiDependencies: Pypi dependencies specified in the environment // configuration, at the time when the build was triggered. PypiDependencies map[string]string `json:"pypiDependencies,omitempty"` // ForceSendFields is a list of field names (e.g. "BuildLogUri") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CheckUpgradeResponse: Message containing information about the result of an upgrade check operation.
func (*CheckUpgradeResponse) MarshalJSON ¶ added in v0.49.0
func (s *CheckUpgradeResponse) MarshalJSON() ([]byte, error)
type CidrBlock ¶ added in v0.61.0
type CidrBlock struct { // CidrBlock: cidr_block must be specified in CIDR notation. CidrBlock string `json:"cidrBlock,omitempty"` // DisplayName: display_name is a field for users to identify CIDR // blocks. DisplayName string `json:"displayName,omitempty"` // ForceSendFields is a list of field names (e.g. "CidrBlock") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CidrBlock: CidrBlock contains an optional name and one CIDR block.
func (*CidrBlock) MarshalJSON ¶ added in v0.61.0
type DatabaseConfig ¶ added in v0.25.0
type DatabaseConfig struct { // MachineType: Optional. Cloud SQL machine type used by Airflow // database. It has to be one of: db-n1-standard-2, db-n1-standard-4, // db-n1-standard-8 or db-n1-standard-16. If not specified, // db-n1-standard-2 will be used. Supported for Cloud Composer // environments in versions composer-1.*.*-airflow-*.*.*. MachineType string `json:"machineType,omitempty"` // 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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DatabaseConfig: The configuration of Cloud SQL instance that is used by the Apache Airflow software.
func (*DatabaseConfig) MarshalJSON ¶ added in v0.25.0
func (s *DatabaseConfig) MarshalJSON() ([]byte, error)
type Date ¶ added in v0.37.0
type Date struct { // Day: Day of a month. Must be from 1 to 31 and valid for the year and // month, or 0 to specify a year by itself or a year and month where the // day isn't significant. Day int64 `json:"day,omitempty"` // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year // without a month and day. Month int64 `json:"month,omitempty"` // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a // date without a year. Year int64 `json:"year,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
func (*Date) MarshalJSON ¶ added in v0.37.0
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
type EncryptionConfig ¶ added in v0.37.0
type EncryptionConfig struct { // KmsKeyName: Optional. Customer-managed Encryption Key available // through Google's Key Management Service. Cannot be updated. If not // specified, Google-managed key will be used. KmsKeyName string `json:"kmsKeyName,omitempty"` // ForceSendFields is a list of field names (e.g. "KmsKeyName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EncryptionConfig: The encryption options for the Cloud Composer environment and its dependencies. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
func (*EncryptionConfig) MarshalJSON ¶ added in v0.37.0
func (s *EncryptionConfig) MarshalJSON() ([]byte, error)
type Environment ¶
type Environment struct { // Config: Configuration parameters for this environment. Config *EnvironmentConfig `json:"config,omitempty"` // CreateTime: Output only. The time at which this environment was // created. CreateTime string `json:"createTime,omitempty"` // Labels: Optional. User-defined labels for this environment. The // labels map can contain no more than 64 entries. Entries of the labels // map are UTF8 strings that comply with the following restrictions: * // Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform // to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are // additionally constrained to be <= 128 bytes in size. Labels map[string]string `json:"labels,omitempty"` // Name: The resource name of the environment, in the form: // "projects/{projectId}/locations/{locationId}/environments/{environment // Id}" EnvironmentId must start with a lowercase letter followed by up // to 63 lowercase letters, numbers, or hyphens, and cannot end with a // hyphen. Name string `json:"name,omitempty"` // State: The current state of the environment. // // Possible values: // "STATE_UNSPECIFIED" - The state of the environment is unknown. // "CREATING" - The environment is in the process of being created. // "RUNNING" - The environment is currently running and healthy. It is // ready for use. // "UPDATING" - The environment is being updated. It remains usable // but cannot receive additional update requests or be deleted at this // time. // "DELETING" - The environment is undergoing deletion. It cannot be // used. // "ERROR" - The environment has encountered an error and cannot be // used. State string `json:"state,omitempty"` // UpdateTime: Output only. The time at which this environment was last // modified. UpdateTime string `json:"updateTime,omitempty"` // Uuid: Output only. The UUID (Universally Unique IDentifier) // associated with this environment. This value is generated when the // environment is created. Uuid string `json:"uuid,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Config") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Environment: An environment for running orchestration tasks.
func (*Environment) MarshalJSON ¶
func (s *Environment) MarshalJSON() ([]byte, error)
type EnvironmentConfig ¶
type EnvironmentConfig struct { // AirflowUri: Output only. The URI of the Apache Airflow Web UI hosted // within this environment (see Airflow web interface // (/composer/docs/how-to/accessing/airflow-web-interface)). AirflowUri string `json:"airflowUri,omitempty"` // DagGcsPrefix: Output only. The Cloud Storage prefix of the DAGs for // this environment. Although Cloud Storage objects reside in a flat // namespace, a hierarchical file tree can be simulated using // "/"-delimited object name prefixes. DAG objects for this environment // reside in a simulated directory with the given prefix. DagGcsPrefix string `json:"dagGcsPrefix,omitempty"` // DatabaseConfig: Optional. The configuration settings for Cloud SQL // instance used internally by Apache Airflow software. DatabaseConfig *DatabaseConfig `json:"databaseConfig,omitempty"` // EncryptionConfig: Optional. The encryption options for the Cloud // Composer environment and its dependencies. Cannot be updated. EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"` // EnvironmentSize: Optional. The size of the Cloud Composer // environment. This field is supported for Cloud Composer environments // in versions composer-2.*.*-airflow-*.*.* and newer. // // Possible values: // "ENVIRONMENT_SIZE_UNSPECIFIED" - The size of the environment is // unspecified. // "ENVIRONMENT_SIZE_SMALL" - The environment size is small. // "ENVIRONMENT_SIZE_MEDIUM" - The environment size is medium. // "ENVIRONMENT_SIZE_LARGE" - The environment size is large. EnvironmentSize string `json:"environmentSize,omitempty"` // GkeCluster: Output only. The Kubernetes Engine cluster used to run // this environment. GkeCluster string `json:"gkeCluster,omitempty"` // MaintenanceWindow: Optional. The maintenance window is the period // when Cloud Composer components may undergo maintenance. It is defined // so that maintenance is not executed during peak hours or critical // time periods. The system will not be under maintenance for every // occurrence of this window, but when maintenance is planned, it will // be scheduled during the window. The maintenance window period must // encompass at least 12 hours per week. This may be split into multiple // chunks, each with a size of at least 4 hours. If this value is // omitted, Cloud Composer components may be subject to maintenance at // any time. MaintenanceWindow *MaintenanceWindow `json:"maintenanceWindow,omitempty"` // MasterAuthorizedNetworksConfig: Optional. The configuration options // for GKE clusters 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: The configuration used for the Kubernetes Engine cluster. NodeConfig *NodeConfig `json:"nodeConfig,omitempty"` // NodeCount: The number of nodes in the Kubernetes Engine cluster that // will be used to run this environment. This field is supported for // Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. NodeCount int64 `json:"nodeCount,omitempty"` // PrivateEnvironmentConfig: The configuration used for the Private IP // Cloud Composer environment. PrivateEnvironmentConfig *PrivateEnvironmentConfig `json:"privateEnvironmentConfig,omitempty"` // SoftwareConfig: 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. This field is supported for Cloud // Composer environments in versions composer-1.*.*-airflow-*.*.*. 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. "AirflowUri") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AirflowUri") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EnvironmentConfig: Configuration information for an environment.
func (*EnvironmentConfig) MarshalJSON ¶
func (s *EnvironmentConfig) MarshalJSON() ([]byte, error)
type IPAllocationPolicy ¶ added in v0.3.0
type IPAllocationPolicy struct { // ClusterIpv4CidrBlock: Optional. The IP address range used to allocate // IP addresses to pods in the 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. Specify `cluster_secondary_range_name` or // `cluster_ipv4_cidr_block` but not both. ClusterIpv4CidrBlock string `json:"clusterIpv4CidrBlock,omitempty"` // ClusterSecondaryRangeName: Optional. The name of the cluster's // secondary range used to allocate IP addresses to pods. Specify either // `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` but not // both. For Cloud Composer environments in versions // composer-1.*.*-airflow-*.*.*, this field is applicable only when // `use_ip_aliases` is true. ClusterSecondaryRangeName string `json:"clusterSecondaryRangeName,omitempty"` // ServicesIpv4CidrBlock: Optional. The IP address range of the services // IP addresses in this 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. Specify `services_secondary_range_name` or // `services_ipv4_cidr_block` but not both. ServicesIpv4CidrBlock string `json:"servicesIpv4CidrBlock,omitempty"` // ServicesSecondaryRangeName: Optional. The name of the services' // secondary range used to allocate IP addresses to the cluster. Specify // either `services_secondary_range_name` or `services_ipv4_cidr_block` // but not both. For Cloud Composer environments in versions // composer-1.*.*-airflow-*.*.*, this field is applicable only when // `use_ip_aliases` is true. ServicesSecondaryRangeName string `json:"servicesSecondaryRangeName,omitempty"` // UseIpAliases: Optional. Whether or not to enable Alias IPs in the GKE // cluster. If `true`, a VPC-native cluster is created. This field is // only supported for Cloud Composer environments in versions // composer-1.*.*-airflow-*.*.*. Environments in newer versions always // use VPC-native GKE clusters. UseIpAliases bool `json:"useIpAliases,omitempty"` // ForceSendFields is a list of field names (e.g. // "ClusterIpv4CidrBlock") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
IPAllocationPolicy: Configuration for controlling how IPs are allocated in the GKE cluster.
func (*IPAllocationPolicy) MarshalJSON ¶ added in v0.3.0
func (s *IPAllocationPolicy) MarshalJSON() ([]byte, error)
type ImageVersion ¶ added in v0.2.0
type ImageVersion struct { // CreationDisabled: Whether it is impossible to create an environment // with the image version. CreationDisabled bool `json:"creationDisabled,omitempty"` // ImageVersionId: The string identifier of the ImageVersion, in the // form: "composer-x.y.z-airflow-a.b.c" ImageVersionId string `json:"imageVersionId,omitempty"` // IsDefault: Whether this is the default ImageVersion used by Composer // during environment creation if no input ImageVersion is specified. IsDefault bool `json:"isDefault,omitempty"` // ReleaseDate: The date of the version release. ReleaseDate *Date `json:"releaseDate,omitempty"` // SupportedPythonVersions: supported python versions SupportedPythonVersions []string `json:"supportedPythonVersions,omitempty"` // UpgradeDisabled: Whether it is impossible to upgrade an environment // running with the image version. UpgradeDisabled bool `json:"upgradeDisabled,omitempty"` // ForceSendFields is a list of field names (e.g. "CreationDisabled") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ImageVersion: Image Version information
func (*ImageVersion) MarshalJSON ¶ added in v0.2.0
func (s *ImageVersion) MarshalJSON() ([]byte, error)
type ListEnvironmentsResponse ¶
type ListEnvironmentsResponse struct { // Environments: The list of environments returned by a // ListEnvironmentsRequest. Environments []*Environment `json:"environments,omitempty"` // NextPageToken: The page token used to query for the next page if one // exists. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Environments") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListEnvironmentsResponse: The environments in a project and location.
func (*ListEnvironmentsResponse) MarshalJSON ¶
func (s *ListEnvironmentsResponse) MarshalJSON() ([]byte, error)
type ListImageVersionsResponse ¶ added in v0.2.0
type ListImageVersionsResponse struct { // ImageVersions: The list of supported ImageVersions in a location. ImageVersions []*ImageVersion `json:"imageVersions,omitempty"` // NextPageToken: The page token used to query for the next page if one // exists. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ImageVersions") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListImageVersionsResponse: The ImageVersions in a project and location.
func (*ListImageVersionsResponse) MarshalJSON ¶ added in v0.2.0
func (s *ListImageVersionsResponse) MarshalJSON() ([]byte, error)
type ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type LoadSnapshotResponse ¶ added in v0.71.0
type LoadSnapshotResponse struct { }
LoadSnapshotResponse: Response to LoadSnapshotRequest.
type MaintenanceWindow ¶ added in v0.37.0
type MaintenanceWindow struct { // EndTime: Required. Maintenance window end time. It is used only to // calculate the duration of the maintenance window. The value for // end_time must be in the future, relative to `start_time`. EndTime string `json:"endTime,omitempty"` // Recurrence: Required. Maintenance window recurrence. Format is a // subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) `RRULE`. The // only allowed values for `FREQ` field are `FREQ=DAILY` and // `FREQ=WEEKLY;BYDAY=...` Example values: `FREQ=WEEKLY;BYDAY=TU,WE`, // `FREQ=DAILY`. Recurrence string `json:"recurrence,omitempty"` // StartTime: Required. Start time of the first recurrence of the // maintenance window. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MaintenanceWindow: The configuration settings for Cloud Composer maintenance window. The following example: ``` { "startTime":"2019-08-01T01:00:00Z" "endTime":"2019-08-01T07:00:00Z" "recurrence":"FREQ=WEEKLY;BYDAY=TU,WE" } ``` would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.
func (*MaintenanceWindow) MarshalJSON ¶ added in v0.37.0
func (s *MaintenanceWindow) MarshalJSON() ([]byte, error)
type MasterAuthorizedNetworksConfig ¶ added in v0.61.0
type MasterAuthorizedNetworksConfig struct { // CidrBlocks: cidr_blocks define up to 50 external networks that could // access Kubernetes master through HTTPS. CidrBlocks []*CidrBlock `json:"cidrBlocks,omitempty"` // Enabled: Whether or not master authorized networks is enabled. Enabled bool `json:"enabled,omitempty"` // ForceSendFields is a list of field names (e.g. "CidrBlocks") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MasterAuthorizedNetworksConfig: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
func (*MasterAuthorizedNetworksConfig) MarshalJSON ¶ added in v0.61.0
func (s *MasterAuthorizedNetworksConfig) MarshalJSON() ([]byte, error)
type NodeConfig ¶
type NodeConfig struct { // DiskSizeGb: Optional. The disk size in GB used for node VMs. Minimum // size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. // This field is supported for Cloud Composer environments in versions // composer-1.*.*-airflow-*.*.*. DiskSizeGb int64 `json:"diskSizeGb,omitempty"` // EnableIpMasqAgent: Optional. Deploys 'ip-masq-agent' daemon set in // the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range // so IP masquerading is used for all destination addresses, except // between pods traffic. See: // https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent EnableIpMasqAgent bool `json:"enableIpMasqAgent,omitempty"` // IpAllocationPolicy: Optional. The IPAllocationPolicy fields for the // GKE cluster. IpAllocationPolicy *IPAllocationPolicy `json:"ipAllocationPolicy,omitempty"` // Location: Optional. The Compute Engine zone // (/compute/docs/regions-zones) in which to deploy the VMs used to run // the Apache Airflow software, specified as a relative resource name // (/apis/design/resource_names#relative_resource_name). For example: // "projects/{projectId}/zones/{zoneId}". This `location` must belong to // the enclosing environment's project and location. If both this field // and `nodeConfig.machineType` are specified, `nodeConfig.machineType` // must belong to this `location`; if both are unspecified, the service // will pick a zone in the Compute Engine region corresponding to the // Cloud Composer location, and propagate that choice to both fields. If // only one field (`location` or `nodeConfig.machineType`) is specified, // the location information from the specified field will be propagated // to the unspecified field. This field is supported for Cloud Composer // environments in versions composer-1.*.*-airflow-*.*.*. Location string `json:"location,omitempty"` // MachineType: Optional. The Compute Engine machine type // (/compute/docs/machine-types) used for cluster instances, specified // as a relative resource name // (/apis/design/resource_names#relative_resource_name). For example: // "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". // The `machineType` must belong to the enclosing environment's project // and location. If both this field and `nodeConfig.location` are // specified, this `machineType` must belong to the // `nodeConfig.location`; if both are unspecified, the service will pick // a zone in the Compute Engine region corresponding to the Cloud // Composer location, and propagate that choice to both fields. If // exactly one of this field and `nodeConfig.location` is specified, the // location information from the specified field will be propagated to // the unspecified field. The `machineTypeId` must not be a shared-core // machine type (/compute/docs/machine-types#sharedcore). If this field // is unspecified, the `machineTypeId` defaults to "n1-standard-1". This // field is supported for Cloud Composer environments in versions // composer-1.*.*-airflow-*.*.*. MachineType string `json:"machineType,omitempty"` // MaxPodsPerNode: Optional. The maximum number of pods per node in the // Cloud Composer GKE cluster. The value must be between 8 and 110 and // it can be set only if the environment is VPC-native. The default // value is 32. Values of this field will be propagated both to the // `default-pool` node pool of the newly created GKE cluster, and to the // default "Maximum Pods per Node" value which is used for newly created // node pools if their value is not explicitly set during node pool // creation. For more information, see [Optimizing IP address // allocation] // (https://cloud.google.com/kubernetes-engine/docs/how-to/flexible-pod-cidr). // Cannot be updated. This field is supported for Cloud Composer // environments in versions composer-1.*.*-airflow-*.*.*. MaxPodsPerNode int64 `json:"maxPodsPerNode,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 in the environment's project is used. If a Custom // Subnet Network (/vpc/docs/vpc#vpc_networks_and_subnets) is provided, // `nodeConfig.subnetwork` must also be provided. For Shared VPC // (/vpc/docs/shared-vpc) subnetwork requirements, see // `nodeConfig.subnetwork`. Network string `json:"network,omitempty"` // OauthScopes: Optional. The set of Google API scopes to be made // available on all node VMs. If `oauth_scopes` is empty, defaults to // ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be // updated. This field is supported for Cloud Composer environments in // versions composer-1.*.*-airflow-*.*.*. OauthScopes []string `json:"oauthScopes,omitempty"` // ServiceAccount: Optional. The Google Cloud Platform Service Account // to be used by the workloads. If a service account is not specified, // the "default" Compute Engine service account is used. Cannot be // updated. ServiceAccount string `json:"serviceAccount,omitempty"` // Subnetwork: Optional. The Compute Engine subnetwork to be used for // machine communications, specified as a relative resource name // (/apis/design/resource_names#relative_resource_name). For example: // "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" // If a subnetwork is provided, `nodeConfig.network` must also be // provided, and the subnetwork must belong to the enclosing // environment's project and location. Subnetwork string `json:"subnetwork,omitempty"` // Tags: Optional. The list of instance tags applied to all node VMs. // Tags are used to identify valid sources or targets for network // firewalls. Each tag within the list must comply with RFC1035 // (https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. This field // is supported for Cloud Composer environments in versions // composer-1.*.*-airflow-*.*.*. Tags []string `json:"tags,omitempty"` // ForceSendFields is a list of field names (e.g. "DiskSizeGb") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DiskSizeGb") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NodeConfig: The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
func (*NodeConfig) MarshalJSON ¶
func (s *NodeConfig) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. If `true`, the operation is completed, and either `error` // or `response` is available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. It // typically contains progress information and common metadata such as // create time. Some services might not provide such metadata. Any // method that returns a long-running operation should document the // metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that originally returns it. If you use the default HTTP // mapping, the `name` should be a resource name ending with // `operations/{unique_id}`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. If // the original method returns no data on success, such as `Delete`, the // response is `google.protobuf.Empty`. If the original method is // standard `Get`/`Create`/`Update`, the response should be the // resource. For other methods, the response should have the type // `XxxResponse`, where `Xxx` is the original method name. For example, // if the original method name is `TakeSnapshot()`, the inferred // response type is `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type OperationMetadata ¶
type OperationMetadata struct { // CreateTime: Output only. The time the operation was submitted to the // server. CreateTime string `json:"createTime,omitempty"` // EndTime: Output only. The time when the operation terminated, // regardless of its success. This field is unset if the operation is // still ongoing. EndTime string `json:"endTime,omitempty"` // OperationType: Output only. The type of operation being performed. // // Possible values: // "TYPE_UNSPECIFIED" - Unused. // "CREATE" - A resource creation operation. // "DELETE" - A resource deletion operation. // "UPDATE" - A resource update operation. // "CHECK" - A resource check operation. // "SAVE_SNAPSHOT" - Saves snapshot of the resource operation. // "LOAD_SNAPSHOT" - Loads snapshot of the resource operation. OperationType string `json:"operationType,omitempty"` // Resource: Output only. The resource being operated on, as a relative // resource name ( /apis/design/resource_names#relative_resource_name). Resource string `json:"resource,omitempty"` // ResourceUuid: Output only. The UUID of the resource being operated // on. ResourceUuid string `json:"resourceUuid,omitempty"` // State: Output only. The current operation state. // // Possible values: // "STATE_UNSPECIFIED" - Unused. // "PENDING" - The operation has been created but is not yet started. // "RUNNING" - The operation is underway. // "SUCCESSFUL" - The operation completed successfully. // "FAILED" - The operation is no longer running but did not succeed. State string `json:"state,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
OperationMetadata: Metadata describing an operation.
func (*OperationMetadata) MarshalJSON ¶
func (s *OperationMetadata) MarshalJSON() ([]byte, error)
type PrivateClusterConfig ¶ added in v0.3.0
type PrivateClusterConfig struct { // EnablePrivateEndpoint: Optional. If `true`, access to the public // endpoint of the GKE cluster is denied. EnablePrivateEndpoint bool `json:"enablePrivateEndpoint,omitempty"` // MasterIpv4CidrBlock: Optional. The CIDR block from which IPv4 range // for GKE master will be reserved. If left blank, the default value of // '172.16.0.0/23' is used. MasterIpv4CidrBlock string `json:"masterIpv4CidrBlock,omitempty"` // MasterIpv4ReservedRange: Output only. The IP range in CIDR notation // to use for the hosted master network. This range is used for // assigning internal IP addresses to the cluster master or set of // masters and to the internal load balancer virtual IP. This range must // not overlap with any other ranges in use within the cluster's // network. MasterIpv4ReservedRange string `json:"masterIpv4ReservedRange,omitempty"` // ForceSendFields is a list of field names (e.g. // "EnablePrivateEndpoint") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
PrivateClusterConfig: Configuration options for the private GKE cluster in a Cloud Composer environment.
func (*PrivateClusterConfig) MarshalJSON ¶ added in v0.3.0
func (s *PrivateClusterConfig) MarshalJSON() ([]byte, error)
type PrivateEnvironmentConfig ¶ added in v0.3.0
type PrivateEnvironmentConfig struct { // CloudComposerConnectionSubnetwork: Optional. When specified, the // environment will use Private Service Connect instead of VPC peerings // to connect to Cloud SQL in the Tenant Project, and the PSC endpoint // in the Customer Project will use an IP address from this subnetwork. CloudComposerConnectionSubnetwork string `json:"cloudComposerConnectionSubnetwork,omitempty"` // CloudComposerNetworkIpv4CidrBlock: Optional. The CIDR block from // which IP range for Cloud Composer Network in tenant project will be // reserved. Needs to be disjoint from // private_cluster_config.master_ipv4_cidr_block and // cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer // environments in versions composer-2.*.*-airflow-*.*.* and newer. CloudComposerNetworkIpv4CidrBlock string `json:"cloudComposerNetworkIpv4CidrBlock,omitempty"` // CloudComposerNetworkIpv4ReservedRange: Output only. The IP range // reserved for the tenant project's Cloud Composer network. This field // is supported for Cloud Composer environments in versions // composer-2.*.*-airflow-*.*.* and newer. CloudComposerNetworkIpv4ReservedRange string `json:"cloudComposerNetworkIpv4ReservedRange,omitempty"` // CloudSqlIpv4CidrBlock: Optional. The CIDR block from which IP range // in tenant project will be reserved for Cloud SQL. Needs to be // disjoint from web_server_ipv4_cidr_block CloudSqlIpv4CidrBlock string `json:"cloudSqlIpv4CidrBlock,omitempty"` // EnablePrivateEnvironment: Optional. If `true`, a Private IP Cloud // Composer environment is created. If this field is set to true, // `IPAllocationPolicy.use_ip_aliases` must be set to true for Cloud // Composer environments in versions composer-1.*.*-airflow-*.*.*. EnablePrivateEnvironment bool `json:"enablePrivateEnvironment,omitempty"` // EnablePrivatelyUsedPublicIps: Optional. When enabled, IPs from public // (non-RFC1918) ranges can be used for // `IPAllocationPolicy.cluster_ipv4_cidr_block` and // `IPAllocationPolicy.service_ipv4_cidr_block`. EnablePrivatelyUsedPublicIps bool `json:"enablePrivatelyUsedPublicIps,omitempty"` // PrivateClusterConfig: Optional. Configuration for the private GKE // cluster for a Private IP Cloud Composer environment. PrivateClusterConfig *PrivateClusterConfig `json:"privateClusterConfig,omitempty"` // WebServerIpv4CidrBlock: Optional. The CIDR block from which IP range // for web server will be reserved. Needs to be disjoint from // private_cluster_config.master_ipv4_cidr_block and // cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer // environments in versions composer-1.*.*-airflow-*.*.*. WebServerIpv4CidrBlock string `json:"webServerIpv4CidrBlock,omitempty"` // WebServerIpv4ReservedRange: Output only. The IP range reserved for // the tenant project's App Engine VMs. This field is supported for // Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. WebServerIpv4ReservedRange string `json:"webServerIpv4ReservedRange,omitempty"` // ForceSendFields is a list of field names (e.g. // "CloudComposerConnectionSubnetwork") to unconditionally include in // API requests. By default, fields with empty or default values are // omitted from API requests. However, any non-pointer, non-interface // field appearing in ForceSendFields will be sent to the server // regardless of whether the field is empty or not. This may be used to // include empty fields in Patch requests. 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. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
PrivateEnvironmentConfig: The configuration information for configuring a Private IP Cloud Composer environment.
func (*PrivateEnvironmentConfig) MarshalJSON ¶ added in v0.3.0
func (s *PrivateEnvironmentConfig) MarshalJSON() ([]byte, error)
type ProjectsLocationsEnvironmentsCheckUpgradeCall ¶ added in v0.49.0
type ProjectsLocationsEnvironmentsCheckUpgradeCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Context ¶ added in v0.49.0
func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsCheckUpgradeCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Do ¶ added in v0.49.0
func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "composer.projects.locations.environments.checkUpgrade" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Fields ¶ added in v0.49.0
func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsCheckUpgradeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsEnvironmentsCheckUpgradeCall) Header ¶ added in v0.49.0
func (c *ProjectsLocationsEnvironmentsCheckUpgradeCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsEnvironmentsCreateCall ¶
type ProjectsLocationsEnvironmentsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsEnvironmentsCreateCall) Context ¶
func (c *ProjectsLocationsEnvironmentsCreateCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsEnvironmentsCreateCall) Do ¶
func (c *ProjectsLocationsEnvironmentsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "composer.projects.locations.environments.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsEnvironmentsCreateCall) Fields ¶
func (c *ProjectsLocationsEnvironmentsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsEnvironmentsCreateCall) Header ¶
func (c *ProjectsLocationsEnvironmentsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsEnvironmentsDeleteCall ¶
type ProjectsLocationsEnvironmentsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsEnvironmentsDeleteCall) Context ¶
func (c *ProjectsLocationsEnvironmentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsEnvironmentsDeleteCall) Do ¶
func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "composer.projects.locations.environments.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsEnvironmentsDeleteCall) Fields ¶
func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsEnvironmentsDeleteCall) Header ¶
func (c *ProjectsLocationsEnvironmentsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsEnvironmentsGetCall ¶
type ProjectsLocationsEnvironmentsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsEnvironmentsGetCall) Context ¶
func (c *ProjectsLocationsEnvironmentsGetCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsEnvironmentsGetCall) Do ¶
func (c *ProjectsLocationsEnvironmentsGetCall) Do(opts ...googleapi.CallOption) (*Environment, error)
Do executes the "composer.projects.locations.environments.get" call. Exactly one of *Environment or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Environment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsEnvironmentsGetCall) Fields ¶
func (c *ProjectsLocationsEnvironmentsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsEnvironmentsGetCall) Header ¶
func (c *ProjectsLocationsEnvironmentsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsEnvironmentsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsEnvironmentsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsEnvironmentsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsEnvironmentsListCall ¶
type ProjectsLocationsEnvironmentsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsEnvironmentsListCall) Context ¶
func (c *ProjectsLocationsEnvironmentsListCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsEnvironmentsListCall) Do ¶
func (c *ProjectsLocationsEnvironmentsListCall) Do(opts ...googleapi.CallOption) (*ListEnvironmentsResponse, error)
Do executes the "composer.projects.locations.environments.list" call. Exactly one of *ListEnvironmentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListEnvironmentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsEnvironmentsListCall) Fields ¶
func (c *ProjectsLocationsEnvironmentsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsEnvironmentsListCall) Header ¶
func (c *ProjectsLocationsEnvironmentsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsEnvironmentsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsEnvironmentsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsEnvironmentsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsEnvironmentsListCall) PageSize ¶
func (c *ProjectsLocationsEnvironmentsListCall) PageSize(pageSize int64) *ProjectsLocationsEnvironmentsListCall
PageSize sets the optional parameter "pageSize": The maximum number of environments to return.
func (*ProjectsLocationsEnvironmentsListCall) PageToken ¶
func (c *ProjectsLocationsEnvironmentsListCall) PageToken(pageToken string) *ProjectsLocationsEnvironmentsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (*ProjectsLocationsEnvironmentsListCall) Pages ¶
func (c *ProjectsLocationsEnvironmentsListCall) Pages(ctx context.Context, f func(*ListEnvironmentsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsEnvironmentsPatchCall ¶
type ProjectsLocationsEnvironmentsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsEnvironmentsPatchCall) Context ¶
func (c *ProjectsLocationsEnvironmentsPatchCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsEnvironmentsPatchCall) Do ¶
func (c *ProjectsLocationsEnvironmentsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "composer.projects.locations.environments.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsEnvironmentsPatchCall) Fields ¶
func (c *ProjectsLocationsEnvironmentsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsEnvironmentsPatchCall) Header ¶
func (c *ProjectsLocationsEnvironmentsPatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsEnvironmentsPatchCall) UpdateMask ¶
func (c *ProjectsLocationsEnvironmentsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsEnvironmentsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of argparse, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.argparse". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and argparse will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:** Only the following fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI package *packagename*, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the `config.softwareConfig.pypiPackages` mask. * `labels` * Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * `labels.`labelName * Set the label named *labelName*, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the `labels` mask. * `config.nodeCount` * Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerNetworkAccessControl` * Replace the environment's current WebServerNetworkAccessControl. * `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the Apache Airflow config property *name* in the section named *section*, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the `config.softwareConfig.airflowConfigOverrides` mask. * `config.softwareConfig.envVariables` * Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables. * `config.softwareConfig.imageVersion` * Upgrade the version of the environment in-place. Refer to `SoftwareConfig.image_version` for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list (/composer/docs/concepts/versioning/composer-versions) for valid values. * `config.softwareConfig.schedulerCount` * Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the `config.softwareConfig.schedulerCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerConfig.machineType` * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.maintenanceWindow` * Maintenance window during which Cloud Composer components may be under maintenance. * `config.workloadsConfig` * The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. * `config.environmentSize` * The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.
type ProjectsLocationsEnvironmentsRestartWebServerCall ¶ added in v0.37.0
type ProjectsLocationsEnvironmentsRestartWebServerCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsEnvironmentsRestartWebServerCall) Context ¶ added in v0.37.0
func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsRestartWebServerCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsEnvironmentsRestartWebServerCall) Do ¶ added in v0.37.0
func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "composer.projects.locations.environments.restartWebServer" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsEnvironmentsRestartWebServerCall) Fields ¶ added in v0.37.0
func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsRestartWebServerCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsEnvironmentsRestartWebServerCall) Header ¶ added in v0.37.0
func (c *ProjectsLocationsEnvironmentsRestartWebServerCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsEnvironmentsService ¶
type ProjectsLocationsEnvironmentsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsEnvironmentsService ¶
func NewProjectsLocationsEnvironmentsService(s *Service) *ProjectsLocationsEnvironmentsService
func (*ProjectsLocationsEnvironmentsService) CheckUpgrade ¶ added in v0.49.0
func (r *ProjectsLocationsEnvironmentsService) CheckUpgrade(environment string, checkupgraderequest *CheckUpgradeRequest) *ProjectsLocationsEnvironmentsCheckUpgradeCall
CheckUpgrade: Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.
- environment: The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environme ntId}".
func (*ProjectsLocationsEnvironmentsService) Create ¶
func (r *ProjectsLocationsEnvironmentsService) Create(parent string, environment *Environment) *ProjectsLocationsEnvironmentsCreateCall
Create: Create a new environment.
- parent: The parent must be of the form "projects/{projectId}/locations/{locationId}".
func (*ProjectsLocationsEnvironmentsService) Delete ¶
func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall
Delete: Delete an environment.
- name: The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environme ntId}".
func (*ProjectsLocationsEnvironmentsService) Get ¶
func (r *ProjectsLocationsEnvironmentsService) Get(name string) *ProjectsLocationsEnvironmentsGetCall
Get: Get an existing environment.
- name: The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environme ntId}".
func (*ProjectsLocationsEnvironmentsService) List ¶
func (r *ProjectsLocationsEnvironmentsService) List(parent string) *ProjectsLocationsEnvironmentsListCall
List: List environments.
- parent: List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}".
func (*ProjectsLocationsEnvironmentsService) Patch ¶
func (r *ProjectsLocationsEnvironmentsService) Patch(name string, environment *Environment) *ProjectsLocationsEnvironmentsPatchCall
Patch: Update an environment.
- name: The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environme ntId}".
func (*ProjectsLocationsEnvironmentsService) RestartWebServer ¶ added in v0.37.0
func (r *ProjectsLocationsEnvironmentsService) RestartWebServer(name string, restartwebserverrequest *RestartWebServerRequest) *ProjectsLocationsEnvironmentsRestartWebServerCall
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/{environme ntId}".
type ProjectsLocationsImageVersionsListCall ¶ added in v0.2.0
type ProjectsLocationsImageVersionsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsImageVersionsListCall) Context ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) Context(ctx context.Context) *ProjectsLocationsImageVersionsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsImageVersionsListCall) Do ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) Do(opts ...googleapi.CallOption) (*ListImageVersionsResponse, error)
Do executes the "composer.projects.locations.imageVersions.list" call. Exactly one of *ListImageVersionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListImageVersionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsImageVersionsListCall) Fields ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsImageVersionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsImageVersionsListCall) Header ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsImageVersionsListCall) IfNoneMatch ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsImageVersionsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsImageVersionsListCall) IncludePastReleases ¶ added in v0.37.0
func (c *ProjectsLocationsImageVersionsListCall) IncludePastReleases(includePastReleases bool) *ProjectsLocationsImageVersionsListCall
IncludePastReleases sets the optional parameter "includePastReleases": Whether or not image versions from old releases should be included.
func (*ProjectsLocationsImageVersionsListCall) PageSize ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) PageSize(pageSize int64) *ProjectsLocationsImageVersionsListCall
PageSize sets the optional parameter "pageSize": The maximum number of image_versions to return.
func (*ProjectsLocationsImageVersionsListCall) PageToken ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) PageToken(pageToken string) *ProjectsLocationsImageVersionsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (*ProjectsLocationsImageVersionsListCall) Pages ¶ added in v0.2.0
func (c *ProjectsLocationsImageVersionsListCall) Pages(ctx context.Context, f func(*ListImageVersionsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsImageVersionsService ¶ added in v0.2.0
type ProjectsLocationsImageVersionsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsImageVersionsService ¶ added in v0.2.0
func NewProjectsLocationsImageVersionsService(s *Service) *ProjectsLocationsImageVersionsService
func (*ProjectsLocationsImageVersionsService) List ¶ added in v0.2.0
func (r *ProjectsLocationsImageVersionsService) List(parent string) *ProjectsLocationsImageVersionsListCall
List: List ImageVersions for provided location.
- parent: List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}".
type ProjectsLocationsOperationsDeleteCall ¶
type ProjectsLocationsOperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsDeleteCall) Context ¶
func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsDeleteCall) Do ¶
func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "composer.projects.locations.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsDeleteCall) Fields ¶
func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsDeleteCall) Header ¶
func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsOperationsGetCall ¶
type ProjectsLocationsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsGetCall) Context ¶
func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsGetCall) Do ¶
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "composer.projects.locations.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsGetCall) Fields ¶
func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsGetCall) Header ¶
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsOperationsListCall ¶
type ProjectsLocationsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsListCall) Context ¶
func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsListCall) Do ¶
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "composer.projects.locations.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsListCall) Fields ¶
func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsListCall) Filter ¶
func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsOperationsListCall) Header ¶
func (c *ProjectsLocationsOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsOperationsListCall) PageSize ¶
func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsOperationsListCall) PageToken ¶
func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsOperationsListCall) Pages ¶
func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsOperationsService ¶
type ProjectsLocationsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsOperationsService ¶
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (*ProjectsLocationsOperationsService) Delete ¶
func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- name: The name of the operation resource to be deleted.
func (*ProjectsLocationsOperationsService) Get ¶
func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
func (*ProjectsLocationsOperationsService) List ¶
func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsLocationsService ¶
type ProjectsLocationsService struct { Environments *ProjectsLocationsEnvironmentsService ImageVersions *ProjectsLocationsImageVersionsService Operations *ProjectsLocationsOperationsService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
type ProjectsService ¶
type ProjectsService struct { Locations *ProjectsLocationsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type RestartWebServerRequest ¶ added in v0.37.0
type RestartWebServerRequest struct { }
RestartWebServerRequest: Restart Airflow web server.
type SaveSnapshotResponse ¶ added in v0.71.0
type SaveSnapshotResponse struct { // SnapshotPath: The fully-resolved Cloud Storage path of the created // snapshot, e.g.: // "gs://my-bucket/snapshots/project_location_environment_timestamp". // This field is populated only if the snapshot creation was successful. SnapshotPath string `json:"snapshotPath,omitempty"` // ForceSendFields is a list of field names (e.g. "SnapshotPath") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SaveSnapshotResponse: Response to SaveSnapshotRequest.
func (*SaveSnapshotResponse) MarshalJSON ¶ added in v0.71.0
func (s *SaveSnapshotResponse) MarshalJSON() ([]byte, error)
type SchedulerResource ¶ added in v0.51.0
type SchedulerResource struct { // Count: Optional. The number of schedulers. Count int64 `json:"count,omitempty"` // Cpu: Optional. CPU request and limit for a single Airflow scheduler // replica. Cpu float64 `json:"cpu,omitempty"` // MemoryGb: Optional. Memory (GB) request and limit for a single // Airflow scheduler replica. MemoryGb float64 `json:"memoryGb,omitempty"` // StorageGb: Optional. Storage (GB) request and limit for a single // Airflow scheduler replica. StorageGb float64 `json:"storageGb,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SchedulerResource: Configuration for resources used by Airflow schedulers.
func (*SchedulerResource) MarshalJSON ¶ added in v0.51.0
func (s *SchedulerResource) MarshalJSON() ([]byte, error)
func (*SchedulerResource) UnmarshalJSON ¶ added in v0.51.0
func (s *SchedulerResource) UnmarshalJSON(data []byte) error
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶ added in v0.3.0
NewService creates a new Service.
type SoftwareConfig ¶
type SoftwareConfig struct { // AirflowConfigOverrides: Optional. Apache Airflow configuration // properties to override. Property keys contain the section and // property names, separated by a hyphen, for example // "core-dags_are_paused_at_creation". Section names must not contain // hyphens ("-"), opening square brackets ("["), or closing square // brackets ("]"). The property name must not be empty and must not // contain an equals sign ("=") or semicolon (";"). Section and property // names must not contain a period ("."). Apache Airflow configuration // property names must be written in snake_case // (https://en.wikipedia.org/wiki/Snake_case). Property values can // contain any character, and can be written in any lower/upper case // format. Certain Apache Airflow configuration property values are // blocked (/composer/docs/concepts/airflow-configurations), and cannot // be overridden. AirflowConfigOverrides map[string]string `json:"airflowConfigOverrides,omitempty"` // 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: 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)-airflo // w-([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 and minor versions specified. When an alias is provided, the // server replaces it with the latest Apache Airflow version that // satisfies the alias and is supported in the given Cloud Composer // version. In all cases, the resolved image version is stored in the // same field. See also version list // (/composer/docs/concepts/versioning/composer-versions) and versioning // overview // (/composer/docs/concepts/versioning/composer-versioning-overview). ImageVersion string `json:"imageVersion,omitempty"` // PypiPackages: Optional. Custom Python Package Index (PyPI) packages // to be installed in the environment. Keys refer to the lowercase // package name such as "numpy" and values are the lowercase extras and // version specifier such as "==1.12.0", "[devel,gcp_api]", or // "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to // a version specifier, use the empty string as the value. PypiPackages map[string]string `json:"pypiPackages,omitempty"` // PythonVersion: Optional. The major version of Python used to run the // Apache Airflow scheduler, worker, and webserver processes. Can be set // to '2' or '3'. If not specified, the default is '3'. Cannot be // updated. This field is only supported for Cloud Composer environments // in versions composer-1.*.*-airflow-*.*.*. Environments in newer // versions always use Python major version 3. PythonVersion string `json:"pythonVersion,omitempty"` // SchedulerCount: Optional. The number of schedulers for Airflow. This // field is supported for Cloud Composer environments in versions // composer-1.*.*-airflow-2.*.*. SchedulerCount int64 `json:"schedulerCount,omitempty"` // 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. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. 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. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
SoftwareConfig: Specifies the selection and configuration of software inside the environment.
func (*SoftwareConfig) MarshalJSON ¶
func (s *SoftwareConfig) MarshalJSON() ([]byte, error)
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any user-facing error message should be localized and sent // in the google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
func (*Status) MarshalJSON ¶
type WebServerConfig ¶ added in v0.25.0
type WebServerConfig struct { // MachineType: Optional. Machine type on which Airflow web server is // running. It has to be one of: composer-n1-webserver-2, // composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, // composer-n1-webserver-2 will be used. Value custom is returned only // in response, if Airflow web server parameters were manually changed // to a non-standard values. MachineType string `json:"machineType,omitempty"` // ForceSendFields is a list of field names (e.g. "MachineType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
WebServerConfig: The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
func (*WebServerConfig) MarshalJSON ¶ added in v0.25.0
func (s *WebServerConfig) MarshalJSON() ([]byte, error)
type WebServerNetworkAccessControl ¶ added in v0.18.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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
WebServerNetworkAccessControl: Network-level access control policy for the Airflow web server.
func (*WebServerNetworkAccessControl) MarshalJSON ¶ added in v0.18.0
func (s *WebServerNetworkAccessControl) MarshalJSON() ([]byte, error)
type WebServerResource ¶ added in v0.51.0
type WebServerResource struct { // Cpu: Optional. CPU request and limit for Airflow web server. Cpu float64 `json:"cpu,omitempty"` // MemoryGb: Optional. Memory (GB) request and limit for Airflow web // server. MemoryGb float64 `json:"memoryGb,omitempty"` // StorageGb: Optional. Storage (GB) request and limit for Airflow web // server. StorageGb float64 `json:"storageGb,omitempty"` // ForceSendFields is a list of field names (e.g. "Cpu") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
WebServerResource: Configuration for resources used by Airflow web server.
func (*WebServerResource) MarshalJSON ¶ added in v0.51.0
func (s *WebServerResource) MarshalJSON() ([]byte, error)
func (*WebServerResource) UnmarshalJSON ¶ added in v0.51.0
func (s *WebServerResource) UnmarshalJSON(data []byte) error
type WorkerResource ¶ added in v0.51.0
type WorkerResource struct { // Cpu: Optional. CPU request and limit for a single Airflow worker // replica. Cpu float64 `json:"cpu,omitempty"` // MaxCount: Optional. Maximum number of workers for autoscaling. MaxCount int64 `json:"maxCount,omitempty"` // MemoryGb: Optional. Memory (GB) request and limit for a single // Airflow worker replica. MemoryGb float64 `json:"memoryGb,omitempty"` // MinCount: Optional. Minimum number of workers for autoscaling. MinCount int64 `json:"minCount,omitempty"` // StorageGb: Optional. Storage (GB) request and limit for a single // Airflow worker replica. StorageGb float64 `json:"storageGb,omitempty"` // ForceSendFields is a list of field names (e.g. "Cpu") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
WorkerResource: Configuration for resources used by Airflow workers.
func (*WorkerResource) MarshalJSON ¶ added in v0.51.0
func (s *WorkerResource) MarshalJSON() ([]byte, error)
func (*WorkerResource) UnmarshalJSON ¶ added in v0.51.0
func (s *WorkerResource) UnmarshalJSON(data []byte) error
type WorkloadsConfig ¶ added in v0.51.0
type WorkloadsConfig struct { // Scheduler: Optional. Resources used by Airflow schedulers. Scheduler *SchedulerResource `json:"scheduler,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. "Scheduler") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Scheduler") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
WorkloadsConfig: The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.
func (*WorkloadsConfig) MarshalJSON ¶ added in v0.51.0
func (s *WorkloadsConfig) MarshalJSON() ([]byte, error)