google-api-ruby-client/generated/google/apis/composer_v1/classes.rb

719 lines
32 KiB
Ruby

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ComposerV1
# 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 ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# An environment for running orchestration tasks.
class Environment
include Google::Apis::Core::Hashable
# Configuration information for an environment.
# Corresponds to the JSON property `config`
# @return [Google::Apis::ComposerV1::EnvironmentConfig]
attr_accessor :config
# Output only.
# The time at which this environment was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# 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.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# The resource name of the environment, in the form:
# "projects/`projectId`/locations/`locationId`/environments/`environmentId`"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The current state of the environment.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Output only.
# The time at which this environment was last modified.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
# Output only.
# The UUID (Universally Unique IDentifier) associated with this environment.
# This value is generated when the environment is created.
# Corresponds to the JSON property `uuid`
# @return [String]
attr_accessor :uuid
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@config = args[:config] if args.key?(:config)
@create_time = args[:create_time] if args.key?(:create_time)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@state = args[:state] if args.key?(:state)
@update_time = args[:update_time] if args.key?(:update_time)
@uuid = args[:uuid] if args.key?(:uuid)
end
end
# Configuration information for an environment.
class EnvironmentConfig
include Google::Apis::Core::Hashable
# 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)).
# Corresponds to the JSON property `airflowUri`
# @return [String]
attr_accessor :airflow_uri
# 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.
# Corresponds to the JSON property `dagGcsPrefix`
# @return [String]
attr_accessor :dag_gcs_prefix
# Output only.
# The Kubernetes Engine cluster used to run this environment.
# Corresponds to the JSON property `gkeCluster`
# @return [String]
attr_accessor :gke_cluster
# The configuration information for the Kubernetes Engine nodes running
# the Apache Airflow software.
# Corresponds to the JSON property `nodeConfig`
# @return [Google::Apis::ComposerV1::NodeConfig]
attr_accessor :node_config
# The number of nodes in the Kubernetes Engine cluster that will be
# used to run this environment.
# Corresponds to the JSON property `nodeCount`
# @return [Fixnum]
attr_accessor :node_count
# Specifies the selection and configuration of software inside the environment.
# Corresponds to the JSON property `softwareConfig`
# @return [Google::Apis::ComposerV1::SoftwareConfig]
attr_accessor :software_config
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@airflow_uri = args[:airflow_uri] if args.key?(:airflow_uri)
@dag_gcs_prefix = args[:dag_gcs_prefix] if args.key?(:dag_gcs_prefix)
@gke_cluster = args[:gke_cluster] if args.key?(:gke_cluster)
@node_config = args[:node_config] if args.key?(:node_config)
@node_count = args[:node_count] if args.key?(:node_count)
@software_config = args[:software_config] if args.key?(:software_config)
end
end
# ImageVersion information
class ImageVersion
include Google::Apis::Core::Hashable
# The string identifier of the ImageVersion, in the form:
# "composer-x.y.z-airflow-a.b(.c)"
# Corresponds to the JSON property `imageVersionId`
# @return [String]
attr_accessor :image_version_id
# Whether this is the default ImageVersion used by Composer during
# environment creation if no input ImageVersion is specified.
# Corresponds to the JSON property `isDefault`
# @return [Boolean]
attr_accessor :is_default
alias_method :is_default?, :is_default
# supported python versions
# Corresponds to the JSON property `supportedPythonVersions`
# @return [Array<String>]
attr_accessor :supported_python_versions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@image_version_id = args[:image_version_id] if args.key?(:image_version_id)
@is_default = args[:is_default] if args.key?(:is_default)
@supported_python_versions = args[:supported_python_versions] if args.key?(:supported_python_versions)
end
end
# The environments in a project and location.
class ListEnvironmentsResponse
include Google::Apis::Core::Hashable
# The list of environments returned by a ListEnvironmentsRequest.
# Corresponds to the JSON property `environments`
# @return [Array<Google::Apis::ComposerV1::Environment>]
attr_accessor :environments
# The page token used to query for the next page if one exists.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@environments = args[:environments] if args.key?(:environments)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# The ImageVersions in a project and location.
class ListImageVersionsResponse
include Google::Apis::Core::Hashable
# The list of supported ImageVersions in a location.
# Corresponds to the JSON property `imageVersions`
# @return [Array<Google::Apis::ComposerV1::ImageVersion>]
attr_accessor :image_versions
# The page token used to query for the next page if one exists.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@image_versions = args[:image_versions] if args.key?(:image_versions)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# The response message for Operations.ListOperations.
class ListOperationsResponse
include Google::Apis::Core::Hashable
# The standard List next-page token.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# A list of operations that matches the specified filter in the request.
# Corresponds to the JSON property `operations`
# @return [Array<Google::Apis::ComposerV1::Operation>]
attr_accessor :operations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@operations = args[:operations] if args.key?(:operations)
end
end
# The configuration information for the Kubernetes Engine nodes running
# the Apache Airflow software.
class NodeConfig
include Google::Apis::Core::Hashable
# Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
# If unspecified, defaults to 100GB. Cannot be updated.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# 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.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# 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.
# If this field is unspecified, the `machineTypeId` defaults
# to "n1-standard-1".
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
# 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`".
# [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The
# network must belong to the environment's project. If unspecified, the
# "default" network ID in the environment's project is used. If a
# [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
# is provided, `nodeConfig.subnetwork` must also be provided.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# 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.
# Corresponds to the JSON property `oauthScopes`
# @return [Array<String>]
attr_accessor :oauth_scopes
# Optional. The Google Cloud Platform Service Account to be used by the node
# VMs. If a service account is not specified, the "default" Compute Engine
# service account is used. Cannot be updated.
# Corresponds to the JSON property `serviceAccount`
# @return [String]
attr_accessor :service_account
# 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.
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
# 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.
# Corresponds to the JSON property `tags`
# @return [Array<String>]
attr_accessor :tags
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@location = args[:location] if args.key?(:location)
@machine_type = args[:machine_type] if args.key?(:machine_type)
@network = args[:network] if args.key?(:network)
@oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes)
@service_account = args[:service_account] if args.key?(:service_account)
@subnetwork = args[:subnetwork] if args.key?(:subnetwork)
@tags = args[:tags] if args.key?(:tags)
end
end
# This resource represents a long-running operation that is the result of a
# network API call.
class Operation
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error
# message, and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` that can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
# Corresponds to the JSON property `error`
# @return [Google::Apis::ComposerV1::Status]
attr_accessor :error
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@done = args[:done] if args.key?(:done)
@error = args[:error] if args.key?(:error)
@metadata = args[:metadata] if args.key?(:metadata)
@name = args[:name] if args.key?(:name)
@response = args[:response] if args.key?(:response)
end
end
# Metadata describing an operation.
class OperationMetadata
include Google::Apis::Core::Hashable
# Output only.
# The time the operation was submitted to the server.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only.
# The time when the operation terminated, regardless of its success.
# This field is unset if the operation is still ongoing.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Output only.
# The type of operation being performed.
# Corresponds to the JSON property `operationType`
# @return [String]
attr_accessor :operation_type
# Output only.
# The resource being operated on, as a [relative resource name](
# /apis/design/resource_names#relative_resource_name).
# Corresponds to the JSON property `resource`
# @return [String]
attr_accessor :resource
# Output only.
# The UUID of the resource being operated on.
# Corresponds to the JSON property `resourceUuid`
# @return [String]
attr_accessor :resource_uuid
# Output only.
# The current operation state.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@end_time = args[:end_time] if args.key?(:end_time)
@operation_type = args[:operation_type] if args.key?(:operation_type)
@resource = args[:resource] if args.key?(:resource)
@resource_uuid = args[:resource_uuid] if args.key?(:resource_uuid)
@state = args[:state] if args.key?(:state)
end
end
# Specifies the selection and configuration of software inside the environment.
class SoftwareConfig
include Google::Apis::Core::Hashable
# 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
# [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#
# airflow_configuration_blacklists),
# and cannot be overridden.
# Corresponds to the JSON property `airflowConfigOverrides`
# @return [Hash<String,String>]
attr_accessor :airflow_config_overrides
# 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`
# Corresponds to the JSON property `envVariables`
# @return [Hash<String,String>]
attr_accessor :env_variables
# 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]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
# When used as input, the server also checks if the provided version is
# supported and denies the request for an unsupported version.
# The Cloud Composer portion of the version is a
# [semantic version](https://semver.org) or `latest`. When the patch version
# is omitted, the current Cloud Composer patch version is selected.
# When `latest` is provided instead of an explicit version number,
# the server replaces `latest` with the current Cloud Composer version
# and stores that version number in the same field.
# The portion of the image version that follows <em>airflow-</em> is an
# official Apache Airflow repository
# [release name](https://github.com/apache/incubator-airflow/releases).
# See also [Version
# List](/composer/docs/concepts/versioning/composer-versions).
# Corresponds to the JSON property `imageVersion`
# @return [String]
attr_accessor :image_version
# 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.
# Corresponds to the JSON property `pypiPackages`
# @return [Hash<String,String>]
attr_accessor :pypi_packages
# 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 '2'. Cannot be
# updated.
# Corresponds to the JSON property `pythonVersion`
# @return [String]
attr_accessor :python_version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@airflow_config_overrides = args[:airflow_config_overrides] if args.key?(:airflow_config_overrides)
@env_variables = args[:env_variables] if args.key?(:env_variables)
@image_version = args[:image_version] if args.key?(:image_version)
@pypi_packages = args[:pypi_packages] if args.key?(:pypi_packages)
@python_version = args[:python_version] if args.key?(:python_version)
end
end
# 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). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error
# message, and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` that can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
class Status
include Google::Apis::Core::Hashable
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# 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.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@details = args[:details] if args.key?(:details)
@message = args[:message] if args.key?(:message)
end
end
end
end
end