From d0e6cc48df2d0a00d91ce6fbab83aa82146f3573 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Sat, 15 May 2021 07:10:22 +0000 Subject: [PATCH] feat(genomics): update the api #### genomics:v1 The following keys were deleted: - resources.operations.methods.cancel (Total Keys: 12) - resources.operations.methods.get (Total Keys: 11) - resources.operations.methods.list (Total Keys: 18) - schemas.CancelOperationRequest (Total Keys: 2) - schemas.ComputeEngine (Total Keys: 7) - schemas.Empty (Total Keys: 2) - schemas.ListOperationsResponse (Total Keys: 5) - schemas.Operation (Total Keys: 33) - schemas.RuntimeMetadata (Total Keys: 3) - schemas.Status (Total Keys: 8) The following keys were added: - schemas.Accelerator (Total Keys: 5) - schemas.Action (Total Keys: 23) - schemas.Disk (Total Keys: 7) - schemas.ExistingDisk (Total Keys: 3) - schemas.Metadata (Total Keys: 13) - schemas.Mount (Total Keys: 5) - schemas.NFSMount (Total Keys: 3) - schemas.Network (Total Keys: 5) - schemas.PersistentDisk (Total Keys: 6) - schemas.Pipeline (Total Keys: 10) - schemas.Resources (Total Keys: 8) - schemas.Secret (Total Keys: 4) - schemas.ServiceAccount (Total Keys: 5) - schemas.VirtualMachine (Total Keys: 22) - schemas.Volume (Total Keys: 6) - version_module (Total Keys: 1) #### genomics:v2alpha1 The following keys were deleted: - schemas.ComputeEngine (Total Keys: 7) - schemas.OperationEvent (Total Keys: 6) - schemas.OperationMetadata (Total Keys: 18) - schemas.RuntimeMetadata (Total Keys: 3) --- docs/dyn/genomics_v1.html | 5 - ...genomics_v2alpha1.projects.operations.html | 2 +- .../documents/genomics.v1.json | 628 +++++++++++------- .../documents/genomics.v2alpha1.json | 122 +--- 4 files changed, 385 insertions(+), 372 deletions(-) diff --git a/docs/dyn/genomics_v1.html b/docs/dyn/genomics_v1.html index e9bed7bf85c..fd851d5acb1 100644 --- a/docs/dyn/genomics_v1.html +++ b/docs/dyn/genomics_v1.html @@ -74,11 +74,6 @@

Genomics API

Instance Methods

-

- operations() -

-

Returns the operations Resource.

-

close()

Close httplib2 connections.

diff --git a/docs/dyn/genomics_v2alpha1.projects.operations.html b/docs/dyn/genomics_v2alpha1.projects.operations.html index ffbb1c5e793..b8158e70723 100644 --- a/docs/dyn/genomics_v2alpha1.projects.operations.html +++ b/docs/dyn/genomics_v2alpha1.projects.operations.html @@ -160,7 +160,7 @@

Method Details

Args: name: string, The name of the operation's parent resource. (required) - filter: string, A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` + filter: string, A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` pageSize: integer, The maximum number of results to return. The maximum value is 256. pageToken: string, The standard list page token. x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/genomics.v1.json b/googleapiclient/discovery_cache/documents/genomics.v1.json index 93ddcd28cbf..1fe0e184aed 100644 --- a/googleapiclient/discovery_cache/documents/genomics.v1.json +++ b/googleapiclient/discovery_cache/documents/genomics.v1.json @@ -1,16 +1,4 @@ { - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "See, edit, configure, and delete your Google Cloud Platform data" - }, - "https://www.googleapis.com/auth/genomics": { - "description": "View and manage Genomics data" - } - } - } - }, "basePath": "", "baseUrl": "https://genomics.googleapis.com/", "batchPath": "batch", @@ -106,139 +94,122 @@ } }, "protocol": "rest", - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`", - "flatPath": "v1/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "genomics.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "request": { - "$ref": "CancelOperationRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ] - }, - "get": { - "description": "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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`", - "flatPath": "v1/operations/{operationsId}", - "httpMethod": "GET", - "id": "genomics.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`", - "flatPath": "v1/operations", - "httpMethod": "GET", - "id": "genomics.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.\"key with space\" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^operations$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The maximum number of results to return. The maximum value is 256.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ] - } - } - } - }, - "revision": "20210503", + "resources": {}, + "revision": "20210512", "rootUrl": "https://genomics.googleapis.com/", "schemas": { - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, + "Accelerator": { + "description": "Carries information about an accelerator that can be attached to a VM.", + "id": "Accelerator", + "properties": { + "count": { + "description": "How many accelerators of this type to attach.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "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.", + "type": "string" + } + }, "type": "object" }, - "ComputeEngine": { - "description": "Describes a Compute Engine resource that is being managed by a running pipeline.", - "id": "ComputeEngine", + "Action": { + "description": "Specifies a single action that runs a Docker container.", + "id": "Action", "properties": { - "diskNames": { - "description": "The names of the disks that were created for this pipeline.", + "commands": { + "description": "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.", "items": { "type": "string" }, "type": "array" }, - "instanceName": { - "description": "The instance on which the operation is running.", + "credentials": { + "$ref": "Secret", + "description": "If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys." + }, + "encryptedEnvironment": { + "$ref": "Secret", + "description": "The encrypted environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field." + }, + "entrypoint": { + "description": "If specified, overrides the `ENTRYPOINT` specified in the container.", "type": "string" }, - "machineType": { - "description": "The machine type of the instance.", + "environment": { + "additionalProperties": { + "type": "string" + }, + "description": "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.", + "type": "object" + }, + "flags": { + "description": "The set of flags to apply to this action.", + "items": { + "enum": [ + "FLAG_UNSPECIFIED", + "IGNORE_EXIT_STATUS", + "RUN_IN_BACKGROUND", + "ALWAYS_RUN", + "ENABLE_FUSE", + "PUBLISH_EXPOSED_PORTS", + "DISABLE_IMAGE_PREFETCH", + "DISABLE_STANDARD_ERROR_CAPTURE", + "BLOCK_EXTERNAL_NETWORK" + ], + "enumDescriptions": [ + "Unspecified flag.", + "Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.", + "This flag allows an action to continue running in the background while executing subsequent actions. This is useful to provide services to other actions (or to provide debugging support tools like SSH servers).", + "By default, after an action fails, no further actions are run. This flag indicates that this action must be run even if the pipeline has already failed. This is useful for actions that copy output files off of the VM or for debugging. Note that no actions will be run if image prefetching fails.", + "Enable access to the FUSE device for this action. Filesystems can then be mounted into disks shared with other actions. The other actions do not need the `ENABLE_FUSE` flag to access the mounted filesystem. This has the effect of causing the container to be executed with `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only for containers you trust.", + "Exposes all ports specified by `EXPOSE` statements in the container. To discover the host side port numbers, consult the `ACTION_STARTED` event in the operation metadata.", + "All container images are typically downloaded before any actions are executed. This helps prevent typos in URIs or issues like lack of disk space from wasting large amounts of compute resources. If set, this flag prevents the worker from downloading the image until just before the action is executed.", + "A small portion of the container's standard error stream is typically captured and returned inside the `ContainerStoppedEvent`. Setting this flag disables this functionality.", + "Prevents the container from accessing the external network." + ], + "type": "string" + }, + "type": "array" + }, + "imageUri": { + "description": "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.", "type": "string" }, - "zone": { - "description": "The availability zone in which the instance resides.", + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "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.", + "type": "object" + }, + "mounts": { + "description": "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. ", + "items": { + "$ref": "Mount" + }, + "type": "array" + }, + "name": { + "description": "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 hyphens and cannot start with a hyphen.", + "type": "string" + }, + "pidNamespace": { + "description": "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.", + "type": "string" + }, + "portMappings": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "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.", + "type": "object" + }, + "timeout": { + "description": "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.", + "format": "google-duration", "type": "string" } }, @@ -319,10 +290,28 @@ }, "type": "object" }, - "Empty": { - "description": "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 `{}`.", - "id": "Empty", - "properties": {}, + "Disk": { + "description": "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. Specify either `Volume` or `Disk`, but not both.", + "id": "Disk", + "properties": { + "name": { + "description": "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 hyphens and cannot start with a hyphen.", + "type": "string" + }, + "sizeGb": { + "description": "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.", + "format": "int32", + "type": "integer" + }, + "sourceImage": { + "description": "An optional image to put on the disk before attaching it to the VM.", + "type": "string" + }, + "type": { + "description": "The Compute Engine disk type. If unspecified, `pd-standard` is used.", + "type": "string" + } + }, "type": "object" }, "Event": { @@ -349,6 +338,17 @@ }, "type": "object" }, + "ExistingDisk": { + "description": "Configuration for an existing disk to be attached to the VM.", + "id": "ExistingDisk", + "properties": { + "disk": { + "description": "If `disk` contains slashes, the Cloud Life Sciences API assumes that it is a complete URL for the disk. If `disk` does not contain slashes, the Cloud Life Sciences API assumes that the disk is a zonal disk and a URL will be generated of the form `zones//disks/`, where `` is the zone in which the instance is allocated. The disk must be ext4 formatted. If all `Mount` references to this disk have the `read_only` flag set to true, the disk will be attached in `read-only` mode and can be shared with other instances. Otherwise, the disk will be available for writing but cannot be shared.", + "type": "string" + } + }, + "type": "object" + }, "FailedEvent": { "description": "An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.", "id": "FailedEvent", @@ -402,135 +402,144 @@ }, "type": "object" }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", + "Metadata": { + "description": "Carries information about the pipeline execution that is returned in the long running operation's metadata field.", + "id": "Metadata", "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", + "createTime": { + "description": "The time at which the operation was created by the API.", + "format": "google-datetime", "type": "string" }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", + "endTime": { + "description": "The time at which execution was completed and resources were cleaned up.", + "format": "google-datetime", + "type": "string" + }, + "events": { + "description": "The list of events that have happened so far during the execution of this operation.", "items": { - "$ref": "Operation" + "$ref": "Event" }, "type": "array" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "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.", - "type": "boolean" }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { + "labels": { "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "type": "string" }, - "description": "An OperationMetadata or Metadata object. This will always be returned with the Operation.", + "description": "The user-defined labels associated with this operation.", "type": "object" }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", - "type": "string" + "pipeline": { + "$ref": "Pipeline", + "description": "The pipeline this operation represents." }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "An Empty object.", - "type": "object" + "startTime": { + "description": "The first time at which resources were allocated to execute the pipeline.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "OperationEvent": { - "description": "An event that occurred during an Operation.", - "id": "OperationEvent", + "Mount": { + "description": "Carries information about a particular disk mount inside a container.", + "id": "Mount", "properties": { - "description": { - "description": "Required description of event.", + "disk": { + "description": "The name of the disk to mount, as specified in the resources section.", "type": "string" }, - "endTime": { - "description": "Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time.", - "format": "google-datetime", + "path": { + "description": "The path to mount the disk inside the container.", "type": "string" }, - "startTime": { - "description": "Optional time of when event started.", - "format": "google-datetime", + "readOnly": { + "description": "If true, the disk is mounted read-only inside the container.", + "type": "boolean" + } + }, + "type": "object" + }, + "NFSMount": { + "description": "Configuration for an `NFSMount` to be attached to the VM.", + "id": "NFSMount", + "properties": { + "target": { + "description": "A target NFS mount. The target must be specified as `address:/mount\".", "type": "string" } }, "type": "object" }, - "OperationMetadata": { - "description": "Metadata describing an Operation.", - "id": "OperationMetadata", + "Network": { + "description": "VM networking options.", + "id": "Network", "properties": { - "clientId": { - "description": "This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation.", + "name": { + "description": "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.", "type": "string" }, - "createTime": { - "description": "The time at which the job was submitted to the Genomics service.", - "format": "google-datetime", + "subnetwork": { + "description": "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.", "type": "string" }, - "endTime": { - "description": "The time at which the job stopped running.", - "format": "google-datetime", + "usePrivateAddress": { + "description": "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.", + "type": "boolean" + } + }, + "type": "object" + }, + "PersistentDisk": { + "description": "Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.", + "id": "PersistentDisk", + "properties": { + "sizeGb": { + "description": "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.", + "format": "int32", + "type": "integer" + }, + "sourceImage": { + "description": "An image to put on the disk before attaching it to the VM.", "type": "string" }, - "events": { - "description": "Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.", + "type": { + "description": "The Compute Engine disk type. If unspecified, `pd-standard` is used.", + "type": "string" + } + }, + "type": "object" + }, + "Pipeline": { + "description": "Specifies a series of actions to execute, expressed as Docker containers.", + "id": "Pipeline", + "properties": { + "actions": { + "description": "The list of actions to execute, in the order they are specified.", "items": { - "$ref": "OperationEvent" + "$ref": "Action" }, "type": "array" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optionally provided by the caller when submitting the request that creates the operation.", - "type": "object" - }, - "projectId": { - "description": "The Google Cloud Project in which the job is scoped.", - "type": "string" + "encryptedEnvironment": { + "$ref": "Secret", + "description": "The encrypted environment to pass into every action. Each action can also specify its own encrypted environment. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field." }, - "request": { + "environment": { "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "type": "string" }, - "description": "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.", + "description": "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).", "type": "object" }, - "runtimeMetadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Runtime metadata on this Operation.", - "type": "object" + "resources": { + "$ref": "Resources", + "description": "The resources required for execution." }, - "startTime": { - "description": "The time at which the job began to run.", - "format": "google-datetime", + "timeout": { + "description": "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.", + "format": "google-duration", "type": "string" } }, @@ -558,46 +567,70 @@ }, "type": "object" }, + "Resources": { + "description": "The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail.", + "id": "Resources", + "properties": { + "projectId": { + "description": "The project ID to allocate resources in.", + "type": "string" + }, + "regions": { + "description": "The list of regions allowed for VM allocation. If set, the `zones` field must not be set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "virtualMachine": { + "$ref": "VirtualMachine", + "description": "The virtual machine specification." + }, + "zones": { + "description": "The list of zones allowed for VM allocation. If set, the `regions` field must not be set.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "RunPipelineResponse": { "description": "The response to the RunPipeline method, returned in the operation's result field on success.", "id": "RunPipelineResponse", "properties": {}, "type": "object" }, - "RuntimeMetadata": { - "description": "Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.", - "id": "RuntimeMetadata", + "Secret": { + "description": "Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.", + "id": "Secret", "properties": { - "computeEngine": { - "$ref": "ComputeEngine", - "description": "Execution information specific to Google Compute Engine." + "cipherText": { + "description": "The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited.", + "type": "string" + }, + "keyName": { + "description": "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.", + "type": "string" } }, "type": "object" }, - "Status": { - "description": "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).", - "id": "Status", + "ServiceAccount": { + "description": "Carries information about a Google Cloud service account.", + "id": "ServiceAccount", "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" + "email": { + "description": "Email address of the service account. If not specified, the default Compute Engine service account for the project will be used.", + "type": "string" }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "scopes": { + "description": "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.", "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "type": "string" }, "type": "array" - }, - "message": { - "description": "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.", - "type": "string" } }, "type": "object" @@ -619,6 +652,108 @@ }, "type": "object" }, + "VirtualMachine": { + "description": "Carries information about a Compute Engine VM resource.", + "id": "VirtualMachine", + "properties": { + "accelerators": { + "description": "The list of accelerators to attach to the VM.", + "items": { + "$ref": "Accelerator" + }, + "type": "array" + }, + "bootDiskSizeGb": { + "description": "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.", + "format": "int32", + "type": "integer" + }, + "bootImage": { + "description": "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`.", + "type": "string" + }, + "cpuPlatform": { + "description": "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.", + "type": "string" + }, + "disks": { + "description": "The list of disks to create and attach to the VM. Specify either the `volumes[]` field or the `disks[]` field, but not both.", + "items": { + "$ref": "Disk" + }, + "type": "array" + }, + "dockerCacheImages": { + "description": "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. Any images pulled that are not cached will be stored on the first cache disk instead of the boot disk. Only a single image is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enableStackdriverMonitoring": { + "description": "Whether Stackdriver monitoring should be enabled on the VM.", + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "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.", + "type": "object" + }, + "machineType": { + "description": "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.", + "type": "string" + }, + "network": { + "$ref": "Network", + "description": "The VM network configuration." + }, + "nvidiaDriverVersion": { + "description": "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.", + "type": "string" + }, + "preemptible": { + "description": "If true, allocate a preemptible VM.", + "type": "boolean" + }, + "serviceAccount": { + "$ref": "ServiceAccount", + "description": "The service account to install on the VM. This account does not need any permissions other than those required by the pipeline." + }, + "volumes": { + "description": "The list of disks and other storage to create or attach to the VM. Specify either the `volumes[]` field or the `disks[]` field, but not both.", + "items": { + "$ref": "Volume" + }, + "type": "array" + } + }, + "type": "object" + }, + "Volume": { + "description": "Carries information about storage that can be attached to a VM. Specify either `Volume` or `Disk`, but not both.", + "id": "Volume", + "properties": { + "existingDisk": { + "$ref": "ExistingDisk", + "description": "Configuration for a existing disk." + }, + "nfsMount": { + "$ref": "NFSMount", + "description": "Configuration for an NFS mount." + }, + "persistentDisk": { + "$ref": "PersistentDisk", + "description": "Configuration for a persistent disk." + }, + "volume": { + "description": "A user-supplied name for the volume. Used when mounting the volume into `Actions`. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.", + "type": "string" + } + }, + "type": "object" + }, "WorkerAssignedEvent": { "description": "An event generated after a worker VM has been assigned to run the pipeline.", "id": "WorkerAssignedEvent", @@ -656,5 +791,6 @@ }, "servicePath": "", "title": "Genomics API", - "version": "v1" + "version": "v1", + "version_module": true } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json index d78a1e33397..2d99abdaa25 100644 --- a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json @@ -199,7 +199,7 @@ ], "parameters": { "filter": { - "description": "A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.\"key with space\" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`", + "description": "A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.\"key with space\" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`", "location": "query", "type": "string" }, @@ -301,7 +301,7 @@ } } }, - "revision": "20210503", + "revision": "20210512", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "Accelerator": { @@ -494,32 +494,6 @@ }, "type": "object" }, - "ComputeEngine": { - "description": "Describes a Compute Engine resource that is being managed by a running pipeline.", - "id": "ComputeEngine", - "properties": { - "diskNames": { - "description": "The names of the disks that were created for this pipeline.", - "items": { - "type": "string" - }, - "type": "array" - }, - "instanceName": { - "description": "The instance on which the operation is running.", - "type": "string" - }, - "machineType": { - "description": "The machine type of the instance.", - "type": "string" - }, - "zone": { - "description": "The availability zone in which the instance resides.", - "type": "string" - } - }, - "type": "object" - }, "ContainerKilledEvent": { "description": "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.", "id": "ContainerKilledEvent", @@ -872,87 +846,6 @@ }, "type": "object" }, - "OperationEvent": { - "description": "An event that occurred during an Operation.", - "id": "OperationEvent", - "properties": { - "description": { - "description": "Required description of event.", - "type": "string" - }, - "endTime": { - "description": "Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time.", - "format": "google-datetime", - "type": "string" - }, - "startTime": { - "description": "Optional time of when event started.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "OperationMetadata": { - "description": "Metadata describing an Operation.", - "id": "OperationMetadata", - "properties": { - "clientId": { - "description": "This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation.", - "type": "string" - }, - "createTime": { - "description": "The time at which the job was submitted to the Genomics service.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time at which the job stopped running.", - "format": "google-datetime", - "type": "string" - }, - "events": { - "description": "Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.", - "items": { - "$ref": "OperationEvent" - }, - "type": "array" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optionally provided by the caller when submitting the request that creates the operation.", - "type": "object" - }, - "projectId": { - "description": "The Google Cloud Project in which the job is scoped.", - "type": "string" - }, - "request": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "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.", - "type": "object" - }, - "runtimeMetadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Runtime metadata on this Operation.", - "type": "object" - }, - "startTime": { - "description": "The time at which the job began to run.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, "PersistentDisk": { "description": "Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.", "id": "PersistentDisk", @@ -1086,17 +979,6 @@ "properties": {}, "type": "object" }, - "RuntimeMetadata": { - "description": "Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.", - "id": "RuntimeMetadata", - "properties": { - "computeEngine": { - "$ref": "ComputeEngine", - "description": "Execution information specific to Google Compute Engine." - } - }, - "type": "object" - }, "Secret": { "description": "Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.", "id": "Secret",