generated/google/apis/genomics_v2alpha1/classes.rb in google-api-client-0.43.0 vs generated/google/apis/genomics_v2alpha1/classes.rb in google-api-client-0.44.0

- old
+ new

@@ -29,17 +29,16 @@ # How many accelerators of this type to attach. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count - # The accelerator type string (for example, "nvidia-tesla-k80"). - # Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is - # attached, the required runtime libraries will be made available to all - # containers under `/usr/local/nvidia`. The driver version to install must - # be specified using the NVIDIA driver version parameter on the virtual - # machine specification. Note that attaching a GPU increases the worker VM - # startup time by a few minutes. + # The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU + # accelerators are currently supported. If an NVIDIA GPU is attached, the + # required runtime libraries will be made available to all containers under `/ + # usr/local/nvidia`. The driver version to install must be specified using the + # NVIDIA driver version parameter on the virtual machine specification. Note + # that attaching a GPU increases the worker VM startup time by a few minutes. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -55,124 +54,112 @@ # Specifies a single action that runs a Docker container. class Action include Google::Apis::Core::Hashable - # If specified, overrides the `CMD` specified in the container. If the - # container also has an `ENTRYPOINT` the values are used as entrypoint - # arguments. Otherwise, they are used as a command and arguments to run - # inside the container. + # If specified, overrides the `CMD` specified in the container. If the container + # also has an `ENTRYPOINT` the values are used as entrypoint arguments. + # Otherwise, they are used as a command and arguments to run inside the + # container. # Corresponds to the JSON property `commands` # @return [Array<String>] attr_accessor :commands - # Holds encrypted information that is only decrypted and stored in RAM - # by the worker VM when running the pipeline. + # Holds encrypted information that is only decrypted and stored in RAM by the + # worker VM when running the pipeline. # Corresponds to the JSON property `credentials` # @return [Google::Apis::GenomicsV2alpha1::Secret] attr_accessor :credentials # If specified, overrides the `ENTRYPOINT` specified in the container. # Corresponds to the JSON property `entrypoint` # @return [String] attr_accessor :entrypoint - # The environment to pass into the container. This environment is merged - # with values specified in the google.genomics.v2alpha1.Pipeline - # message, overwriting any duplicate values. - # In addition to the values passed here, a few other values are - # automatically injected into the environment. These cannot be hidden or - # overwritten. - # `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed - # because an action has exited with a non-zero status (and did not have the - # `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional - # debug or logging actions should execute. - # `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last - # non-background action that executed. This can be used by workflow engine - # authors to determine whether an individual action has succeeded or failed. + # The environment to pass into the container. This environment is merged with + # values specified in the google.genomics.v2alpha1.Pipeline message, overwriting + # any duplicate values. In addition to the values passed here, a few other + # values are automatically injected into the environment. These cannot be hidden + # or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline + # failed because an action has exited with a non-zero status (and did not have + # the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if + # additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` + # will be set to the exit status of the last non-background action that executed. + # This can be used by workflow engine authors to determine whether an + # individual action has succeeded or failed. # Corresponds to the JSON property `environment` # @return [Hash<String,String>] attr_accessor :environment # The set of flags to apply to this action. # Corresponds to the JSON property `flags` # @return [Array<String>] attr_accessor :flags # Required. The URI to pull the container image from. Note that all images - # referenced - # by actions in the pipeline are pulled before the first action runs. If - # multiple actions reference the same image, it is only pulled once, - # ensuring that the same image is used for all actions in a single pipeline. - # The image URI can be either a complete host and image specification (e.g., - # quay.io/biocontainers/samtools), a library and image name (e.g., - # google/cloud-sdk) or a bare image name ('bash') to pull from the default - # library. No schema is required in any of these cases. - # If the specified image is not public, the service account specified for - # the Virtual Machine must have access to pull the images from GCR, or - # appropriate credentials must be specified in the - # google.genomics.v2alpha1.Action.credentials field. + # referenced by actions in the pipeline are pulled before the first action runs. + # If multiple actions reference the same image, it is only pulled once, ensuring + # that the same image is used for all actions in a single pipeline. The image + # URI can be either a complete host and image specification (e.g., quay.io/ + # biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or + # a bare image name ('bash') to pull from the default library. No schema is + # required in any of these cases. If the specified image is not public, the + # service account specified for the Virtual Machine must have access to pull the + # images from GCR, or appropriate credentials must be specified in the google. + # genomics.v2alpha1.Action.credentials field. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri - # Labels to associate with the action. This field is provided to assist - # workflow engine authors in identifying actions (for example, to indicate - # what sort of action they perform, such as localization or debugging). - # They are returned in the operation metadata, but are otherwise ignored. + # Labels to associate with the action. This field is provided to assist workflow + # engine authors in identifying actions (for example, to indicate what sort of + # action they perform, such as localization or debugging). They are returned in + # the operation metadata, but are otherwise ignored. # Corresponds to the JSON property `labels` # @return [Hash<String,String>] attr_accessor :labels - # A list of mounts to make available to the action. - # In addition to the values specified here, every action has a special - # virtual disk mounted under `/google` that contains log files and other - # operational components. - # <ul> - # <li><code>/google/logs</code> All logs written during the pipeline - # execution.</li> - # <li><code>/google/logs/output</code> The combined standard output and - # standard error of all actions run as part of the pipeline - # execution.</li> - # <li><code>/google/logs/action/*/stdout</code> The complete contents of - # each individual action's standard output.</li> - # <li><code>/google/logs/action/*/stderr</code> The complete contents of - # each individual action's standard error output.</li> - # </ul> + # A list of mounts to make available to the action. In addition to the values + # specified here, every action has a special virtual disk mounted under `/google` + # that contains log files and other operational components. - /google/logs All + # logs written during the pipeline execution. - /google/logs/output The combined + # standard output and standard error of all actions run as part of the pipeline + # execution. - /google/logs/action/*/stdout The complete contents of each + # individual action's standard output. - /google/logs/action/*/stderr The + # complete contents of each individual action's standard error output. # Corresponds to the JSON property `mounts` # @return [Array<Google::Apis::GenomicsV2alpha1::Mount>] attr_accessor :mounts - # An optional name for the container. The container hostname will be set to - # this name, making it useful for inter-container communication. The name - # must contain only upper and lowercase alphanumeric characters and hypens - # and cannot start with a hyphen. + # An optional name for the container. The container hostname will be set to this + # name, making it useful for inter-container communication. The name must + # contain only upper and lowercase alphanumeric characters and hypens and cannot + # start with a hyphen. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # An optional identifier for a PID namespace to run the action inside. - # Multiple actions should use the same string to share a namespace. If - # unspecified, a separate isolated namespace is used. + # An optional identifier for a PID namespace to run the action inside. Multiple + # actions should use the same string to share a namespace. If unspecified, a + # separate isolated namespace is used. # Corresponds to the JSON property `pidNamespace` # @return [String] attr_accessor :pid_namespace - # A map of containers to host port mappings for this container. If the - # container already specifies exposed ports, use the - # `PUBLISH_EXPOSED_PORTS` flag instead. - # The host port number must be less than 65536. If it is zero, an unused - # random port is assigned. To determine the resulting port number, consult - # the `ContainerStartedEvent` in the operation metadata. + # A map of containers to host port mappings for this container. If the container + # already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. + # The host port number must be less than 65536. If it is zero, an unused random + # port is assigned. To determine the resulting port number, consult the ` + # ContainerStartedEvent` in the operation metadata. # Corresponds to the JSON property `portMappings` # @return [Hash<String,Fixnum>] attr_accessor :port_mappings - # The maximum amount of time to give the action to complete. If the action - # fails to complete before the timeout, it will be terminated and the exit - # status will be non-zero. The pipeline will continue or terminate based - # on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. + # The maximum amount of time to give the action to complete. If the action fails + # to complete before the timeout, it will be terminated and the exit status will + # be non-zero. The pipeline will continue or terminate based on the rules + # defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout def initialize(**args) @@ -211,17 +198,15 @@ # The parameters to the CheckIn method. class CheckInRequest include Google::Apis::Core::Hashable - # 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 ````. + # 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 ````. # Corresponds to the JSON property `deadlineExpired` # @return [Google::Apis::GenomicsV2alpha1::Empty] attr_accessor :deadline_expired # A workflow specific event occurred. @@ -232,20 +217,26 @@ # A list of timestamped events. # Corresponds to the JSON property `events` # @return [Array<Google::Apis::GenomicsV2alpha1::TimestampedEvent>] attr_accessor :events - # 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). + # 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). # Corresponds to the JSON property `result` # @return [Google::Apis::GenomicsV2alpha1::Status] attr_accessor :result + # An SOS report for an unexpected VM failure. + # Corresponds to the JSON property `sosReport` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :sos_report + # The status of the worker VM. # Corresponds to the JSON property `workerStatus` # @return [Google::Apis::GenomicsV2alpha1::WorkerStatus] attr_accessor :worker_status @@ -257,21 +248,22 @@ def update!(**args) @deadline_expired = args[:deadline_expired] if args.key?(:deadline_expired) @event = args[:event] if args.key?(:event) @events = args[:events] if args.key?(:events) @result = args[:result] if args.key?(:result) + @sos_report = args[:sos_report] if args.key?(:sos_report) @worker_status = args[:worker_status] if args.key?(:worker_status) end end # The response to the CheckIn method. class CheckInResponse include Google::Apis::Core::Hashable - # The deadline by which the worker must request an extension. The backend - # will allow for network transmission time and other delays, but the worker - # must attempt to transmit the extension request no later than the deadline. + # The deadline by which the worker must request an extension. The backend will + # allow for network transmission time and other delays, but the worker must + # attempt to transmit the extension request no later than the deadline. # Corresponds to the JSON property `deadline` # @return [String] attr_accessor :deadline # The metadata that describes the operation assigned to the worker. @@ -326,13 +318,13 @@ @machine_type = args[:machine_type] if args.key?(:machine_type) @zone = args[:zone] if args.key?(:zone) end end - # An event generated when a container is forcibly terminated by the - # worker. Currently, this only occurs when the container outlives the - # timeout specified by the user. + # An event generated when a container is forcibly terminated by the worker. + # Currently, this only occurs when the container outlives the timeout specified + # by the user. class ContainerKilledEvent include Google::Apis::Core::Hashable # The numeric ID of the action that started the container. # Corresponds to the JSON property `actionId` @@ -356,21 +348,21 @@ # The numeric ID of the action that started this container. # Corresponds to the JSON property `actionId` # @return [Fixnum] attr_accessor :action_id - # The public IP address that can be used to connect to the container. This - # field is only populated when at least one port mapping is present. If the - # instance was created with a private address, this field will be empty even - # if port mappings exist. + # The public IP address that can be used to connect to the container. This field + # is only populated when at least one port mapping is present. If the instance + # was created with a private address, this field will be empty even if port + # mappings exist. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address - # The container-to-host port mappings installed for this container. This - # set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag - # as well as any specified in the `Action` definition. + # The container-to-host port mappings installed for this container. This set + # will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well + # as any specified in the `Action` definition. # Corresponds to the JSON property `portMappings` # @return [Hash<String,Fixnum>] attr_accessor :port_mappings def initialize(**args) @@ -397,17 +389,17 @@ # The exit status of the container. # Corresponds to the JSON property `exitStatus` # @return [Fixnum] attr_accessor :exit_status - # The tail end of any content written to standard error by the container. - # If the content emits large amounts of debugging noise or contains - # sensitive information, you can prevent the content from being printed by - # setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. - # Note that only a small amount of the end of the stream is captured here. - # The entire stream is stored in the `/google/logs` directory mounted into - # each action, and can be copied off the machine as described elsewhere. + # The tail end of any content written to standard error by the container. If the + # content emits large amounts of debugging noise or contains sensitive + # information, you can prevent the content from being printed by setting the ` + # DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end + # of the stream is captured here. The entire stream is stored in the `/google/ + # logs` directory mounted into each action, and can be copied off the machine as + # described elsewhere. # Corresponds to the JSON property `stderr` # @return [String] attr_accessor :stderr def initialize(**args) @@ -420,26 +412,26 @@ @exit_status = args[:exit_status] if args.key?(:exit_status) @stderr = args[:stderr] if args.key?(:stderr) end end - # An event generated whenever a resource limitation or transient error - # delays execution of a pipeline that was otherwise ready to run. + # An event generated whenever a resource limitation or transient error delays + # execution of a pipeline that was otherwise ready to run. class DelayedEvent include Google::Apis::Core::Hashable - # A textual description of the cause of the delay. The string can change - # without notice because it is often generated by another service (such as - # Compute Engine). + # A textual description of the cause of the delay. The string can change without + # notice because it is often generated by another service (such as Compute + # Engine). # Corresponds to the JSON property `cause` # @return [String] attr_accessor :cause - # If the delay was caused by a resource shortage, this field lists the - # Compute Engine metrics that are preventing this operation from running - # (for example, `CPUS` or `INSTANCES`). If the particular metric is not - # known, a single `UNKNOWN` metric will be present. + # If the delay was caused by a resource shortage, this field lists the Compute + # Engine metrics that are preventing this operation from running (for example, ` + # CPUS` or `INSTANCES`). If the particular metric is not known, a single ` + # UNKNOWN` metric will be present. # Corresponds to the JSON property `metrics` # @return [Array<String>] attr_accessor :metrics def initialize(**args) @@ -451,29 +443,28 @@ @cause = args[:cause] if args.key?(:cause) @metrics = args[:metrics] if args.key?(:metrics) end end - # Carries information about a disk that can be attached to a VM. - # See https://cloud.google.com/compute/docs/disks/performance for more - # information about disk type, size, and performance considerations. + # Carries information about a disk that can be attached to a VM. See https:// + # cloud.google.com/compute/docs/disks/performance for more information about + # disk type, size, and performance considerations. class Disk include Google::Apis::Core::Hashable - # A user-supplied name for the disk. Used when mounting the disk into - # actions. The name must contain only upper and lowercase alphanumeric - # characters and hypens and cannot start with a hyphen. + # A user-supplied name for the disk. Used when mounting the disk into actions. + # The name must contain only upper and lowercase alphanumeric characters and + # hypens and cannot start with a hyphen. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The size, in GB, of the disk to attach. If the size is not - # specified, a default is chosen to ensure reasonable I/O performance. - # If the disk type is specified as `local-ssd`, multiple local drives are - # automatically combined to provide the requested size. Note, however, that - # each physical SSD is 375GB in size, and no more than 8 drives can be - # attached to a single instance. + # The size, in GB, of the disk to attach. If the size is not specified, a + # default is chosen to ensure reasonable I/O performance. If the disk type is + # specified as `local-ssd`, multiple local drives are automatically combined to + # provide the requested size. Note, however, that each physical SSD is 375GB in + # size, and no more than 8 drives can be attached to a single instance. # Corresponds to the JSON property `sizeGb` # @return [Fixnum] attr_accessor :size_gb # An optional image to put on the disk before attaching it to the VM. @@ -522,17 +513,15 @@ @free_space_bytes = args[:free_space_bytes] if args.key?(:free_space_bytes) @total_space_bytes = args[:total_space_bytes] if args.key?(:total_space_bytes) end end - # 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 ````. + # 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) @@ -545,13 +534,13 @@ # Carries information about events that occur during pipeline execution. class Event include Google::Apis::Core::Hashable - # A human-readable description of the event. Note that these strings can - # change at any time without notice. Any application logic must use the - # information in the `details` field. + # A human-readable description of the event. Note that these strings can change + # at any time without notice. Any application logic must use the information in + # the `details` field. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Machine-readable details about the event. @@ -574,12 +563,12 @@ @details = args[:details] if args.key?(:details) @timestamp = args[:timestamp] if args.key?(:timestamp) end end - # An event generated when the execution of a pipeline has failed. Note - # that other events can continue to occur after this event. + # An event generated when the execution of a pipeline has failed. Note that + # other events can continue to occur after this event. class FailedEvent include Google::Apis::Core::Hashable # The human-readable description of the cause of the failure. # Corresponds to the JSON property `cause` @@ -625,12 +614,12 @@ @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @operations = args[:operations] if args.key?(:operations) end end - # Carries information about the pipeline execution that is returned - # in the long running operation's metadata field. + # Carries information about the pipeline execution that is returned in the long + # running operation's metadata field. class Metadata include Google::Apis::Core::Hashable # The time at which the operation was created by the API. # Corresponds to the JSON property `createTime` @@ -712,34 +701,32 @@ # VM networking options. class Network include Google::Apis::Core::Hashable - # The network name to attach the VM's network interface to. The value will - # be prefixed with `global/networks/` unless it contains a `/`, in which - # case it is assumed to be a fully specified network resource URL. - # If unspecified, the global default network is used. + # The network name to attach the VM's network interface to. The value will be + # prefixed with `global/networks/` unless it contains a `/`, in which case it is + # assumed to be a fully specified network resource URL. If unspecified, the + # global default network is used. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # If the specified network is configured for custom subnet creation, the - # name of the subnetwork to attach the instance to must be specified here. - # The value is prefixed with `regions/*/subnetworks/` unless it contains a - # `/`, in which case it is assumed to be a fully specified subnetwork - # resource URL. - # If the `*` character appears in the value, it is replaced with the region - # that the virtual machine has been allocated in. + # If the specified network is configured for custom subnet creation, the name of + # the subnetwork to attach the instance to must be specified here. The value is + # prefixed with `regions/*/subnetworks/` unless it contains a `/`, in which case + # it is assumed to be a fully specified subnetwork resource URL. If the `*` + # character appears in the value, it is replaced with the region that the + # virtual machine has been allocated in. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork - # If set to true, do not attach a public IP address to the VM. Note that - # without a public IP address, additional configuration is required to - # allow the VM to access Google services. - # See https://cloud.google.com/vpc/docs/configure-private-google-access - # for more information. + # If set to true, do not attach a public IP address to the VM. Note that without + # a public IP address, additional configuration is required to allow the VM to + # access Google services. See https://cloud.google.com/vpc/docs/configure- + # private-google-access for more information. # Corresponds to the JSON property `usePrivateAddress` # @return [Boolean] attr_accessor :use_private_address alias_method :use_private_address?, :use_private_address @@ -758,24 +745,23 @@ # 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. + # 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). 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). + # 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). # Corresponds to the JSON property `error` # @return [Google::Apis::GenomicsV2alpha1::Status] attr_accessor :error # An OperationMetadata or Metadata object. This will always be returned with the @@ -783,11 +769,11 @@ # 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. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL- + # originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL- # qzoWAgEw` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -860,31 +846,30 @@ # The time at which the job stopped running. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Optional event messages that were generated during the job's execution. - # This also contains any warnings that were generated during import - # or export. + # Optional event messages that were generated during the job's execution. This + # also contains any warnings that were generated during import or export. # Corresponds to the JSON property `events` # @return [Array<Google::Apis::GenomicsV2alpha1::OperationEvent>] attr_accessor :events - # Optionally provided by the caller when submitting the request that creates - # the operation. + # Optionally provided by the caller when submitting the request that creates the + # operation. # Corresponds to the JSON property `labels` # @return [Hash<String,String>] attr_accessor :labels # The Google Cloud Project in which the job is scoped. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The original request that started the operation. Note that this will be in - # current version of the API. If the operation was started with v1beta2 API - # and a GetOperation is performed on v1 API, a v1 request will be returned. + # current version of the API. If the operation was started with v1beta2 API and + # a GetOperation is performed on v1 API, a v1 request will be returned. # Corresponds to the JSON property `request` # @return [Hash<String,Object>] attr_accessor :request # Runtime metadata on this Operation. @@ -923,27 +908,26 @@ # Corresponds to the JSON property `actions` # @return [Array<Google::Apis::GenomicsV2alpha1::Action>] attr_accessor :actions # The environment to pass into every action. Each action can also specify - # additional environment variables but cannot delete an entry from this map - # (though they can overwrite it with a different value). + # additional environment variables but cannot delete an entry from this map ( + # though they can overwrite it with a different value). # Corresponds to the JSON property `environment` # @return [Hash<String,String>] attr_accessor :environment - # The system resources for the pipeline run. - # At least one zone or region must be specified or the pipeline run will fail. + # The system resources for the pipeline run. At least one zone or region must be + # specified or the pipeline run will fail. # Corresponds to the JSON property `resources` # @return [Google::Apis::GenomicsV2alpha1::Resources] attr_accessor :resources - # The maximum amount of time to give the pipeline to complete. This includes - # the time spent waiting for a worker to be allocated. If the pipeline fails - # to complete before the timeout, it will be cancelled and the error code - # will be set to DEADLINE_EXCEEDED. - # If unspecified, it will default to 7 days. + # The maximum amount of time to give the pipeline to complete. This includes the + # time spent waiting for a worker to be allocated. If the pipeline fails to + # complete before the timeout, it will be cancelled and the error code will be + # set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout def initialize(**args) @@ -995,33 +979,33 @@ def update!(**args) @image_uri = args[:image_uri] if args.key?(:image_uri) end end - # The system resources for the pipeline run. - # At least one zone or region must be specified or the pipeline run will fail. + # The system resources for the pipeline run. At least one zone or region must be + # specified or the pipeline run will fail. class Resources include Google::Apis::Core::Hashable # The project ID to allocate resources in. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # The list of regions allowed for VM allocation. If set, the `zones` field - # must not be set. + # The list of regions allowed for VM allocation. If set, the `zones` field must + # not be set. # Corresponds to the JSON property `regions` # @return [Array<String>] attr_accessor :regions # Carries information about a Compute Engine VM resource. # Corresponds to the JSON property `virtualMachine` # @return [Google::Apis::GenomicsV2alpha1::VirtualMachine] attr_accessor :virtual_machine - # The list of zones allowed for VM allocation. If set, the `regions` field - # must not be set. + # The list of zones allowed for VM allocation. If set, the `regions` field must + # not be set. # Corresponds to the JSON property `zones` # @return [Array<String>] attr_accessor :zones def initialize(**args) @@ -1035,21 +1019,21 @@ @virtual_machine = args[:virtual_machine] if args.key?(:virtual_machine) @zones = args[:zones] if args.key?(:zones) end end - # The arguments to the `RunPipeline` method. The requesting user must have - # the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service - # account or the request will fail. + # The arguments to the `RunPipeline` method. The requesting user must have the ` + # iam.serviceAccounts.actAs` permission for the Cloud Genomics service account + # or the request will fail. class RunPipelineRequest include Google::Apis::Core::Hashable - # User-defined labels to associate with the returned operation. These - # labels are not propagated to any Google Cloud Platform resources used by - # the operation, and can be modified at any time. - # To associate labels with resources created while executing the operation, - # see the appropriate resource message (for example, `VirtualMachine`). + # User-defined labels to associate with the returned operation. These labels are + # not propagated to any Google Cloud Platform resources used by the operation, + # and can be modified at any time. To associate labels with resources created + # while executing the operation, see the appropriate resource message (for + # example, `VirtualMachine`). # Corresponds to the JSON property `labels` # @return [Hash<String,String>] attr_accessor :labels # Specifies a series of actions to execute, expressed as Docker containers. @@ -1080,13 +1064,12 @@ # Update properties of this object def update!(**args) end end - # Runtime metadata that will be populated in the - # runtimeMetadata - # field of the Operation associated with a RunPipeline execution. + # Runtime metadata that will be populated in the runtimeMetadata field of the + # Operation associated with a RunPipeline execution. class RuntimeMetadata include Google::Apis::Core::Hashable # Describes a Compute Engine resource that is being managed by a running # pipeline. @@ -1102,24 +1085,24 @@ def update!(**args) @compute_engine = args[:compute_engine] if args.key?(:compute_engine) end end - # Holds encrypted information that is only decrypted and stored in RAM - # by the worker VM when running the pipeline. + # Holds encrypted information that is only decrypted and stored in RAM by the + # worker VM when running the pipeline. class Secret include Google::Apis::Core::Hashable - # The value of the cipherText response from the `encrypt` method. This field - # is intentionally unaudited. + # The value of the cipherText response from the `encrypt` method. This field is + # intentionally unaudited. # Corresponds to the JSON property `cipherText` # @return [String] attr_accessor :cipher_text - # The name of the Cloud KMS key that will be used to decrypt the secret - # value. The VM service account must have the required permissions and - # authentication scopes to invoke the `decrypt` method on the specified key. + # The name of the Cloud KMS key that will be used to decrypt the secret value. + # The VM service account must have the required permissions and authentication + # scopes to invoke the `decrypt` method on the specified key. # Corresponds to the JSON property `keyName` # @return [String] attr_accessor :key_name def initialize(**args) @@ -1135,18 +1118,18 @@ # Carries information about a Google Cloud service account. class ServiceAccount include Google::Apis::Core::Hashable - # Email address of the service account. If not specified, the default - # Compute Engine service account for the project will be used. + # Email address of the service account. If not specified, the default Compute + # Engine service account for the project will be used. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # List of scopes to be enabled for this service account on the VM, in - # addition to the cloud-platform API scope that will be added by default. + # List of scopes to be enabled for this service account on the VM, in addition + # to the cloud-platform API scope that will be added by default. # Corresponds to the JSON property `scopes` # @return [Array<String>] attr_accessor :scopes def initialize(**args) @@ -1158,33 +1141,33 @@ @email = args[:email] if args.key?(:email) @scopes = args[:scopes] if args.key?(:scopes) 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). 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). + # 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). 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 + # 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. + # 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) @@ -1197,12 +1180,12 @@ @details = args[:details] if args.key?(:details) @message = args[:message] if args.key?(:message) end end - # An event that occured in the operation assigned to the - # worker and the time of occurance. + # An event that occured in the operation assigned to the worker and the time of + # occurance. class TimestampedEvent include Google::Apis::Core::Hashable # The event data. # Corresponds to the JSON property `data` @@ -1223,14 +1206,14 @@ @data = args[:data] if args.key?(:data) @timestamp = args[:timestamp] if args.key?(:timestamp) end end - # An event generated when the execution of a container results in a - # non-zero exit status that was not otherwise ignored. Execution will - # continue, but only actions that are flagged as `ALWAYS_RUN` will be - # executed. Other actions will be skipped. + # An event generated when the execution of a container results in a non-zero + # exit status that was not otherwise ignored. Execution will continue, but only + # actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will + # be skipped. class UnexpectedExitStatusEvent include Google::Apis::Core::Hashable # The numeric ID of the action that started the container. # Corresponds to the JSON property `actionId` @@ -1260,54 +1243,52 @@ # The list of accelerators to attach to the VM. # Corresponds to the JSON property `accelerators` # @return [Array<Google::Apis::GenomicsV2alpha1::Accelerator>] attr_accessor :accelerators - # The size of the boot disk, in GB. The boot disk must be large - # enough to accommodate all of the Docker images from each action in the - # pipeline at the same time. If not specified, a small but reasonable - # default value is used. + # The size of the boot disk, in GB. The boot disk must be large enough to + # accommodate all of the Docker images from each action in the pipeline at the + # same time. If not specified, a small but reasonable default value is used. # Corresponds to the JSON property `bootDiskSizeGb` # @return [Fixnum] attr_accessor :boot_disk_size_gb - # The host operating system image to use. - # Currently, only Container-Optimized OS images can be used. - # The default value is `projects/cos-cloud/global/images/family/cos-stable`, - # which selects the latest stable release of Container-Optimized OS. - # This option is provided to allow testing against the beta release of the - # operating system to ensure that the new version does not interact - # negatively with production pipelines. - # To test a pipeline against the beta release of Container-Optimized OS, - # use the value `projects/cos-cloud/global/images/family/cos-beta`. + # The host operating system image to use. Currently, only Container-Optimized OS + # images can be used. The default value is `projects/cos-cloud/global/images/ + # family/cos-stable`, which selects the latest stable release of Container- + # Optimized OS. This option is provided to allow testing against the beta + # release of the operating system to ensure that the new version does not + # interact negatively with production pipelines. To test a pipeline against the + # beta release of Container-Optimized OS, use the value `projects/cos-cloud/ + # global/images/family/cos-beta`. # Corresponds to the JSON property `bootImage` # @return [String] attr_accessor :boot_image # The CPU platform to request. An instance based on a newer platform can be - # allocated, but never one with fewer capabilities. The value of this - # parameter must be a valid Compute Engine CPU platform name (such as "Intel - # Skylake"). This parameter is only useful for carefully optimized work - # loads where the CPU platform has a significant impact. - # For more information about the effect of this parameter, see - # https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + # allocated, but never one with fewer capabilities. The value of this parameter + # must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). + # This parameter is only useful for carefully optimized work loads where the CPU + # platform has a significant impact. For more information about the effect of + # this parameter, see https://cloud.google.com/compute/docs/instances/specify- + # min-cpu-platform. # Corresponds to the JSON property `cpuPlatform` # @return [String] attr_accessor :cpu_platform # The list of disks to create and attach to the VM. # Corresponds to the JSON property `disks` # @return [Array<Google::Apis::GenomicsV2alpha1::Disk>] attr_accessor :disks # The Compute Engine Disk Images to use as a Docker cache. The disks will be - # mounted into the Docker folder in a way that the images present in the - # cache will not need to be pulled. The digests of the cached images must - # match those of the tags used or the latest version will still be pulled. - # The root directory of the ext4 image must contain `image` and `overlay2` - # directories copied from the Docker directory of a VM where the desired - # Docker images have already been pulled. Only a single image is supported. + # mounted into the Docker folder in a way that the images present in the cache + # will not need to be pulled. The digests of the cached images must match those + # of the tags used or the latest version will still be pulled. The root + # directory of the ext4 image must contain `image` and `overlay2` directories + # copied from the Docker directory of a VM where the desired Docker images have + # already been pulled. Only a single image is supported. # Corresponds to the JSON property `dockerCacheImages` # @return [Array<String>] attr_accessor :docker_cache_images # Whether Stackdriver monitoring should be enabled on the VM. @@ -1315,42 +1296,39 @@ # @return [Boolean] attr_accessor :enable_stackdriver_monitoring alias_method :enable_stackdriver_monitoring?, :enable_stackdriver_monitoring # Optional set of labels to apply to the VM and any attached disk resources. - # These labels must adhere to the [name and value - # restrictions](https://cloud.google.com/compute/docs/labeling-resources) on - # VM labels imposed by Compute Engine. - # Labels keys with the prefix 'google-' are reserved for use by Google. - # Labels applied at creation time to the VM. Applied on a best-effort basis - # to attached disk resources shortly after VM creation. + # These labels must adhere to the [name and value restrictions](https://cloud. + # google.com/compute/docs/labeling-resources) on VM labels imposed by Compute + # Engine. Labels keys with the prefix 'google-' are reserved for use by Google. + # Labels applied at creation time to the VM. Applied on a best-effort basis to + # attached disk resources shortly after VM creation. # Corresponds to the JSON property `labels` # @return [Hash<String,String>] attr_accessor :labels # Required. The machine type of the virtual machine to create. Must be the short - # name - # of a standard machine type (such as "n1-standard-1") or a custom machine - # type (such as "custom-1-4096", where "1" indicates the number of vCPUs and - # "4096" indicates the memory in MB). See - # [Creating an instance with a custom machine - # type](https://cloud.google.com/compute/docs/instances/creating-instance-with- - # custom-machine-type#create) - # for more specifications on creating a custom machine type. + # name of a standard machine type (such as "n1-standard-1") or a custom machine + # type (such as "custom-1-4096", where "1" indicates the number of vCPUs and " + # 4096" indicates the memory in MB). See [Creating an instance with a custom + # machine type](https://cloud.google.com/compute/docs/instances/creating- + # instance-with-custom-machine-type#create) for more specifications on creating + # a custom machine type. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type # VM networking options. # Corresponds to the JSON property `network` # @return [Google::Apis::GenomicsV2alpha1::Network] attr_accessor :network - # The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. - # The version specified here must be compatible with the GPU libraries - # contained in the container being executed, and must be one of the drivers - # hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage. + # The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The + # version specified here must be compatible with the GPU libraries contained in + # the container being executed, and must be one of the drivers hosted in the ` + # nvidia-drivers-us-public` bucket on Google Cloud Storage. # Corresponds to the JSON property `nvidiaDriverVersion` # @return [String] attr_accessor :nvidia_driver_version # If true, allocate a preemptible VM. @@ -1384,12 +1362,11 @@ @preemptible = args[:preemptible] if args.key?(:preemptible) @service_account = args[:service_account] if args.key?(:service_account) end end - # An event generated after a worker VM has been assigned to run the - # pipeline. + # An event generated after a worker VM has been assigned to run the pipeline. class WorkerAssignedEvent include Google::Apis::Core::Hashable # The worker's instance name. # Corresponds to the JSON property `instance` @@ -1416,11 +1393,11 @@ @machine_type = args[:machine_type] if args.key?(:machine_type) @zone = args[:zone] if args.key?(:zone) end end - # An event generated when the worker VM that was assigned to the pipeline - # has been released (deleted). + # An event generated when the worker VM that was assigned to the pipeline has + # been released (deleted). class WorkerReleasedEvent include Google::Apis::Core::Hashable # The worker's instance name. # Corresponds to the JSON property `instance`