UNPKG

@google-cloud/batch

Version:
1,243 lines 202 kB
{ "nested": { "google": { "nested": { "cloud": { "nested": { "batch": { "nested": { "v1": { "options": { "csharp_namespace": "Google.Cloud.Batch.V1", "go_package": "cloud.google.com/go/batch/apiv1/batchpb;batchpb", "java_multiple_files": true, "java_outer_classname": "VolumeProto", "java_package": "com.google.cloud.batch.v1", "objc_class_prefix": "GCB", "php_namespace": "Google\\Cloud\\Batch\\V1", "ruby_package": "Google::Cloud::Batch::V1" }, "nested": { "BatchService": { "options": { "(google.api.default_host)": "batch.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "CreateJob": { "requestType": "CreateJobRequest", "responseType": "Job", "options": { "(google.api.http).post": "/v1/{parent=projects/*/locations/*}/jobs", "(google.api.http).body": "job", "(google.api.method_signature)": "parent,job,job_id" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*/locations/*}/jobs", "body": "job" } }, { "(google.api.method_signature)": "parent,job,job_id" } ] }, "GetJob": { "requestType": "GetJobRequest", "responseType": "Job", "options": { "(google.api.http).get": "/v1/{name=projects/*/locations/*/jobs/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=projects/*/locations/*/jobs/*}" } }, { "(google.api.method_signature)": "name" } ] }, "DeleteJob": { "requestType": "DeleteJobRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).delete": "/v1/{name=projects/*/locations/*/jobs/*}", "(google.api.method_signature)": "name", "(google.longrunning.operation_info).response_type": "google.protobuf.Empty", "(google.longrunning.operation_info).metadata_type": "google.cloud.batch.v1.OperationMetadata" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v1/{name=projects/*/locations/*/jobs/*}" } }, { "(google.api.method_signature)": "name" }, { "(google.longrunning.operation_info)": { "response_type": "google.protobuf.Empty", "metadata_type": "google.cloud.batch.v1.OperationMetadata" } } ] }, "CancelJob": { "requestType": "CancelJobRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v1/{name=projects/*/locations/*/jobs/*}:cancel", "(google.api.http).body": "*", "(google.api.method_signature)": "name", "(google.longrunning.operation_info).response_type": "google.cloud.batch.v1.CancelJobResponse", "(google.longrunning.operation_info).metadata_type": "google.cloud.batch.v1.OperationMetadata" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/locations/*/jobs/*}:cancel", "body": "*" } }, { "(google.api.method_signature)": "name" }, { "(google.longrunning.operation_info)": { "response_type": "google.cloud.batch.v1.CancelJobResponse", "metadata_type": "google.cloud.batch.v1.OperationMetadata" } } ] }, "ListJobs": { "requestType": "ListJobsRequest", "responseType": "ListJobsResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*/locations/*}/jobs", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*/locations/*}/jobs" } }, { "(google.api.method_signature)": "parent" } ] }, "GetTask": { "requestType": "GetTaskRequest", "responseType": "Task", "options": { "(google.api.http).get": "/v1/{name=projects/*/locations/*/jobs/*/taskGroups/*/tasks/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=projects/*/locations/*/jobs/*/taskGroups/*/tasks/*}" } }, { "(google.api.method_signature)": "name" } ] }, "ListTasks": { "requestType": "ListTasksRequest", "responseType": "ListTasksResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*/locations/*/jobs/*/taskGroups/*}/tasks", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*/locations/*/jobs/*/taskGroups/*}/tasks" } }, { "(google.api.method_signature)": "parent" } ] } } }, "CreateJobRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "batch.googleapis.com/Job" } }, "jobId": { "type": "string", "id": 2 }, "job": { "type": "Job", "id": 3, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "requestId": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "GetJobRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "batch.googleapis.com/Job" } } } }, "DeleteJobRequest": { "fields": { "name": { "type": "string", "id": 1 }, "reason": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "requestId": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "CancelJobRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "batch.googleapis.com/Job" } }, "requestId": { "type": "string", "id": 4, "options": { "(google.api.field_info).format": "UUID4", "(google.api.field_behavior)": "OPTIONAL" } } } }, "CancelJobResponse": { "fields": {} }, "ListJobsRequest": { "fields": { "parent": { "type": "string", "id": 1 }, "filter": { "type": "string", "id": 4 }, "orderBy": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "pageSize": { "type": "int32", "id": 2 }, "pageToken": { "type": "string", "id": 3 } } }, "ListJobsResponse": { "fields": { "jobs": { "rule": "repeated", "type": "Job", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 }, "unreachable": { "rule": "repeated", "type": "string", "id": 3 } } }, "ListTasksRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "batch.googleapis.com/TaskGroup" } }, "filter": { "type": "string", "id": 2 }, "pageSize": { "type": "int32", "id": 3 }, "pageToken": { "type": "string", "id": 4 } } }, "ListTasksResponse": { "fields": { "tasks": { "rule": "repeated", "type": "Task", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 }, "unreachable": { "rule": "repeated", "type": "string", "id": 3 } } }, "GetTaskRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "batch.googleapis.com/Task" } } } }, "OperationMetadata": { "fields": { "createTime": { "type": "google.protobuf.Timestamp", "id": 1, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "endTime": { "type": "google.protobuf.Timestamp", "id": 2, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "target": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "verb": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "statusMessage": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "requestedCancellation": { "type": "bool", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "apiVersion": { "type": "string", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "Job": { "options": { "(google.api.resource).type": "batch.googleapis.com/Job", "(google.api.resource).pattern": "projects/{project}/locations/{location}/jobs/{job}" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "uid": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "priority": { "type": "int64", "id": 3 }, "taskGroups": { "rule": "repeated", "type": "TaskGroup", "id": 4, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "allocationPolicy": { "type": "AllocationPolicy", "id": 7 }, "labels": { "keyType": "string", "type": "string", "id": 8 }, "status": { "type": "JobStatus", "id": 9, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "createTime": { "type": "google.protobuf.Timestamp", "id": 11, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 12, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "logsPolicy": { "type": "LogsPolicy", "id": 13 }, "notifications": { "rule": "repeated", "type": "JobNotification", "id": 14 } } }, "LogsPolicy": { "fields": { "destination": { "type": "Destination", "id": 1 }, "logsPath": { "type": "string", "id": 2 }, "cloudLoggingOption": { "type": "CloudLoggingOption", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "CloudLoggingOption": { "fields": { "useGenericTaskMonitoredResource": { "type": "bool", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "Destination": { "values": { "DESTINATION_UNSPECIFIED": 0, "CLOUD_LOGGING": 1, "PATH": 2 } } } }, "JobStatus": { "fields": { "state": { "type": "State", "id": 1 }, "statusEvents": { "rule": "repeated", "type": "StatusEvent", "id": 2 }, "taskGroups": { "keyType": "string", "type": "TaskGroupStatus", "id": 4 }, "runDuration": { "type": "google.protobuf.Duration", "id": 5 } }, "nested": { "InstanceStatus": { "fields": { "machineType": { "type": "string", "id": 1 }, "provisioningModel": { "type": "AllocationPolicy.ProvisioningModel", "id": 2 }, "taskPack": { "type": "int64", "id": 3 }, "bootDisk": { "type": "AllocationPolicy.Disk", "id": 4 } } }, "TaskGroupStatus": { "fields": { "counts": { "keyType": "string", "type": "int64", "id": 1 }, "instances": { "rule": "repeated", "type": "InstanceStatus", "id": 2 } } }, "State": { "values": { "STATE_UNSPECIFIED": 0, "QUEUED": 1, "SCHEDULED": 2, "RUNNING": 3, "SUCCEEDED": 4, "FAILED": 5, "DELETION_IN_PROGRESS": 6, "CANCELLATION_IN_PROGRESS": 7, "CANCELLED": 8 } } } }, "JobNotification": { "fields": { "pubsubTopic": { "type": "string", "id": 1 }, "message": { "type": "Message", "id": 2 } }, "nested": { "Message": { "fields": { "type": { "type": "Type", "id": 1 }, "newJobState": { "type": "JobStatus.State", "id": 2 }, "newTaskState": { "type": "TaskStatus.State", "id": 3 } } }, "Type": { "values": { "TYPE_UNSPECIFIED": 0, "JOB_STATE_CHANGED": 1, "TASK_STATE_CHANGED": 2 } } } }, "AllocationPolicy": { "fields": { "location": { "type": "LocationPolicy", "id": 1 }, "instances": { "rule": "repeated", "type": "InstancePolicyOrTemplate", "id": 8 }, "serviceAccount": { "type": "ServiceAccount", "id": 9 }, "labels": { "keyType": "string", "type": "string", "id": 6 }, "network": { "type": "NetworkPolicy", "id": 7 }, "placement": { "type": "PlacementPolicy", "id": 10 }, "tags": { "rule": "repeated", "type": "string", "id": 11, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "LocationPolicy": { "fields": { "allowedLocations": { "rule": "repeated", "type": "string", "id": 1 } } }, "Disk": { "oneofs": { "dataSource": { "oneof": [ "image", "snapshot" ] } }, "fields": { "image": { "type": "string", "id": 4 }, "snapshot": { "type": "string", "id": 5 }, "type": { "type": "string", "id": 1 }, "sizeGb": { "type": "int64", "id": 2 }, "diskInterface": { "type": "string", "id": 6 } } }, "AttachedDisk": { "oneofs": { "attached": { "oneof": [ "newDisk", "existingDisk" ] } }, "fields": { "newDisk": { "type": "Disk", "id": 1 }, "existingDisk": { "type": "string", "id": 2 }, "deviceName": { "type": "string", "id": 3 } } }, "Accelerator": { "fields": { "type": { "type": "string", "id": 1 }, "count": { "type": "int64", "id": 2 }, "installGpuDrivers": { "type": "bool", "id": 3, "options": { "deprecated": true } }, "driverVersion": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "InstancePolicy": { "fields": { "machineType": { "type": "string", "id": 2 }, "minCpuPlatform": { "type": "string", "id": 3 }, "provisioningModel": { "type": "ProvisioningModel", "id": 4 }, "accelerators": { "rule": "repeated", "type": "Accelerator", "id": 5 }, "bootDisk": { "type": "Disk", "id": 8 }, "disks": { "rule": "repeated", "type": "AttachedDisk", "id": 6 }, "reservation": { "type": "string", "id": 7, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "InstancePolicyOrTemplate": { "oneofs": { "policyTemplate": { "oneof": [ "policy", "instanceTemplate" ] } }, "fields": { "policy": { "type": "InstancePolicy", "id": 1 }, "instanceTemplate": { "type": "string", "id": 2 }, "installGpuDrivers": { "type": "bool", "id": 3 }, "installOpsAgent": { "type": "bool", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "blockProjectSshKeys": { "type": "bool", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "NetworkInterface": { "fields": { "network": { "type": "string", "id": 1 }, "subnetwork": { "type": "string", "id": 2 }, "noExternalIpAddress": { "type": "bool", "id": 3 } } }, "NetworkPolicy": { "fields": { "networkInterfaces": { "rule": "repeated", "type": "NetworkInterface", "id": 1 } } }, "PlacementPolicy": { "fields": { "collocation": { "type": "string", "id": 1 }, "maxDistance": { "type": "int64", "id": 2 } } }, "ProvisioningModel": { "values": { "PROVISIONING_MODEL_UNSPECIFIED": 0, "STANDARD": 1, "SPOT": 2, "PREEMPTIBLE": 3 } } } }, "TaskGroup": { "options": { "(google.api.resource).type": "batch.googleapis.com/TaskGroup", "(google.api.resource).pattern": "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "taskSpec": { "type": "TaskSpec", "id": 3, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "taskCount": { "type": "int64", "id": 4 }, "parallelism": { "type": "int64", "id": 5 }, "schedulingPolicy": { "type": "SchedulingPolicy", "id": 6 }, "taskEnvironments": { "rule": "repeated", "type": "Environment", "id": 9 }, "taskCountPerNode": { "type": "int64", "id": 10 }, "requireHostsFile": { "type": "bool", "id": 11 }, "permissiveSsh": { "type": "bool", "id": 12 }, "runAsNonRoot": { "type": "bool", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "SchedulingPolicy": { "values": { "SCHEDULING_POLICY_UNSPECIFIED": 0, "AS_SOON_AS_POSSIBLE": 1, "IN_ORDER": 2 } } } }, "ServiceAccount": { "fields": { "email": { "type": "string", "id": 1 }, "scopes": { "rule": "repeated", "type": "string", "id": 2 } } }, "ComputeResource": { "fields": { "cpuMilli": { "type": "int64", "id": 1 }, "memoryMib": { "type": "int64", "id": 2 }, "bootDiskMib": { "type": "int64", "id": 4 } } }, "StatusEvent": { "fields": { "type": { "type": "string", "id": 3 }, "description": { "type": "string", "id": 1 }, "eventTime": { "type": "google.protobuf.Timestamp", "id": 2 }, "taskExecution": { "type": "TaskExecution", "id": 4 }, "taskState": { "type": "TaskStatus.State", "id": 5 } } }, "TaskExecution": { "fields": { "exitCode": { "type": "int32", "id": 1 } } }, "TaskStatus": { "fields": { "state": { "type": "State", "id": 1 }, "statusEvents": { "rule": "repeated", "type": "StatusEvent", "id": 2 } }, "nested": { "State": { "values": { "STATE_UNSPECIFIED": 0, "PENDING": 1, "ASSIGNED": 2, "RUNNING": 3, "FAILED": 4, "SUCCEEDED": 5, "UNEXECUTED": 6 } } } }, "Runnable": { "oneofs": { "executable": { "oneof": [ "container", "script", "barrier" ] } }, "fields": { "container": { "type": "Container", "id": 1 }, "script": { "type": "Script", "id": 2 }, "barrier": { "type": "Barrier", "id": 6 }, "displayName": { "type": "string", "id": 10, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "ignoreExitStatus": { "type": "bool", "id": 3 }, "background": { "type": "bool", "id": 4 }, "alwaysRun": { "type": "bool", "id": 5 }, "environment": { "type": "Environment", "id": 7 }, "timeout": { "type": "google.protobuf.Duration", "id": 8 }, "labels": { "keyType": "string", "type": "string", "id": 9 } }, "nested": { "Container": { "fields": { "imageUri": { "type": "string", "id": 1 }, "commands": { "rule": "repeated", "type": "string", "id": 2 }, "entrypoint": { "type": "string", "id": 3 }, "volumes": { "rule": "repeated", "type": "string", "id": 7 }, "options": { "type": "string", "id": 8 }, "blockExternalNetwork": { "type": "bool", "id": 9 }, "username": { "type": "string", "id": 10 }, "password": { "type": "string", "id": 11 }, "enableImageStreaming": { "type": "bool", "id": 12, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "Script": { "oneofs": { "command": { "oneof": [ "path", "text" ] } }, "fields": { "path": { "type": "string", "id": 1 }, "text": { "type": "string", "id": 2 } } }, "Barrier": { "fields": { "name": { "type": "string", "id": 1 } } } } }, "TaskSpec": { "fields": { "runnables": { "rule": "repeated", "type": "Runnable", "id": 8 }, "computeResource": { "type": "ComputeResource", "id": 3 }, "maxRunDuration": { "type": "google.protobuf.Duration", "id": 4 }, "maxRetryCount": { "type": "int32", "id": 5 }, "lifecyclePolicies": { "rule": "repeated", "type": "LifecyclePolicy", "id": 9 }, "environments": { "keyType": "string", "type": "string", "id": 6, "options": { "deprecated": true } }, "volumes": { "rule": "repeated", "type": "Volume", "id": 7 }, "environment": { "type": "Environment", "id": 10 } } }, "LifecyclePolicy": { "fields": { "action": { "type": "Action", "id": 1 }, "actionCondition": { "type": "ActionCondition", "id": 2 } }, "nested": { "ActionCondition": { "fields": { "exitCodes": { "rule": "repeated", "type": "int32", "id": 1 } } }, "Action": { "values": { "ACTION_UNSPECIFIED": 0, "RETRY_TASK": 1, "FAIL_TASK": 2 } } } }