cancel(name, body=None, x__xgafv=None)

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.

Args:
  name: string, Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for JobService.CancelNasJob.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a NasJob

Args:
parent: string, Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:

{ # Represents a Neural Architecture Search (NAS) job.
"createTime": "A String", # Output only. Time when the NasJob was created.
"displayName": "A String", # Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"enableRestrictedImageTraining": True or False, # Optional. Enable a separation of Custom model training and restricted image training for tenant project.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a NasJob. If this is set, then all resources created by the NasJob will be encrypted with the provided encryption key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
"error": { # 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). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"labels": { # The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
"name": "A String", # Output only. Resource name of the NasJob.
"nasJobOutput": { # Represents a uCAIP NasJob output. # Output only. Output of the NasJob.
"multiTrialJobOutput": { # The output of a multi-trial Neural Architecture Search (NAS) jobs. # Output only. The output of this multi-trial Neural Architecture Search (NAS) job.
"searchTrials": [ # Output only. List of NasTrials that were started as part of search stage.
{ # Represents a uCAIP NasJob trial.
"endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
"startTime": "A String", # Output only. Time when the NasTrial was started.
"state": "A String", # Output only. The detailed state of the NasTrial.
},
],
"trainTrials": [ # Output only. List of NasTrials that were started as part of train stage.
{ # Represents a uCAIP NasJob trial.
"endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
"startTime": "A String", # Output only. Time when the NasTrial was started.
"state": "A String", # Output only. The detailed state of the NasTrial.
},
],
},
},
"nasJobSpec": { # Represents the spec of a NasJob. # Required. The specification of a NasJob.
"multiTrialAlgorithmSpec": { # The spec of multi-trial Neural Architecture Search (NAS). # The spec of multi-trial algorithms.
"metric": { # Represents a metric to optimize. # Metric specs for the NAS job. Validation for this field is done at `multi_trial_algorithm_spec` field.
"goal": "A String", # Required. The optimization goal of the metric.
"metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces.
},
"multiTrialAlgorithm": "A String", # The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to `REINFORCEMENT_LEARNING`.
"searchTrialSpec": { # Represent spec for search trials. # Required. Spec for search trials.
"maxFailedTrialCount": 42, # The number of failed trials that need to be seen before failing the NasJob. If set to 0, Vertex AI decides how many trials must fail before the whole job fails.
"maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
"maxTrialCount": 42, # Required. The maximum number of Neural Architecture Search (NAS) trials to run.
"searchTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a search trial job. The same spec applies to all search trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
},
"trainTrialSpec": { # Represent spec for train trials. # Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
"frequency": 42, # Required. Frequency of search trials to start train stage. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
"maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
"trainTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a train trial job. The same spec applies to all train trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
},
},
"resumeNasJobId": "A String", # The ID of the existing NasJob in the same Project and Location which will be used to resume search. search_space_spec and nas_algorithm_spec are obtained from previous NasJob hence should not provide them again for this NasJob.
"searchSpaceSpec": "A String", # It defines the search space for Neural Architecture Search (NAS).
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"updateTime": "A String", # Output only. Time when the NasJob was most recently updated.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents a Neural Architecture Search (NAS) job.
"createTime": "A String", # Output only. Time when the NasJob was created.
"displayName": "A String", # Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"enableRestrictedImageTraining": True or False, # Optional. Enable a separation of Custom model training and restricted image training for tenant project.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a NasJob. If this is set, then all resources created by the NasJob will be encrypted with the provided encryption key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
"error": { # 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). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"labels": { # The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
"name": "A String", # Output only. Resource name of the NasJob.
"nasJobOutput": { # Represents a uCAIP NasJob output. # Output only. Output of the NasJob.
"multiTrialJobOutput": { # The output of a multi-trial Neural Architecture Search (NAS) jobs. # Output only. The output of this multi-trial Neural Architecture Search (NAS) job.
"searchTrials": [ # Output only. List of NasTrials that were started as part of search stage.
{ # Represents a uCAIP NasJob trial.
"endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
"startTime": "A String", # Output only. Time when the NasTrial was started.
"state": "A String", # Output only. The detailed state of the NasTrial.
},
],
"trainTrials": [ # Output only. List of NasTrials that were started as part of train stage.
{ # Represents a uCAIP NasJob trial.
"endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
"startTime": "A String", # Output only. Time when the NasTrial was started.
"state": "A String", # Output only. The detailed state of the NasTrial.
},
],
},
},
"nasJobSpec": { # Represents the spec of a NasJob. # Required. The specification of a NasJob.
"multiTrialAlgorithmSpec": { # The spec of multi-trial Neural Architecture Search (NAS). # The spec of multi-trial algorithms.
"metric": { # Represents a metric to optimize. # Metric specs for the NAS job. Validation for this field is done at `multi_trial_algorithm_spec` field.
"goal": "A String", # Required. The optimization goal of the metric.
"metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces.
},
"multiTrialAlgorithm": "A String", # The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to `REINFORCEMENT_LEARNING`.
"searchTrialSpec": { # Represent spec for search trials. # Required. Spec for search trials.
"maxFailedTrialCount": 42, # The number of failed trials that need to be seen before failing the NasJob. If set to 0, Vertex AI decides how many trials must fail before the whole job fails.
"maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
"maxTrialCount": 42, # Required. The maximum number of Neural Architecture Search (NAS) trials to run.
"searchTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a search trial job. The same spec applies to all search trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
},
"trainTrialSpec": { # Represent spec for train trials. # Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
"frequency": 42, # Required. Frequency of search trials to start train stage. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
"maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
"trainTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a train trial job. The same spec applies to all train trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
},
},
"resumeNasJobId": "A String", # The ID of the existing NasJob in the same Project and Location which will be used to resume search. search_space_spec and nas_algorithm_spec are obtained from previous NasJob hence should not provide them again for this NasJob.
"searchSpaceSpec": "A String", # It defines the search space for Neural Architecture Search (NAS).
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"updateTime": "A String", # Output only. Time when the NasJob was most recently updated.
}

delete(name, x__xgafv=None)

Deletes a NasJob.

Args:
name: string, Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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 error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets a NasJob

Args:
  name: string, Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Neural Architecture Search (NAS) job.
  "createTime": "A String", # Output only. Time when the NasJob was created.
  "displayName": "A String", # Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  "enableRestrictedImageTraining": True or False, # Optional. Enable a separation of Custom model training and restricted image training for tenant project.
  "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a NasJob. If this is set, then all resources created by the NasJob will be encrypted with the provided encryption key.
    "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  "endTime": "A String", # Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
  "error": { # 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). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # 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.
  },
  "labels": { # The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
    "a_key": "A String",
  },
  "name": "A String", # Output only. Resource name of the NasJob.
  "nasJobOutput": { # Represents a uCAIP NasJob output. # Output only. Output of the NasJob.
    "multiTrialJobOutput": { # The output of a multi-trial Neural Architecture Search (NAS) jobs. # Output only. The output of this multi-trial Neural Architecture Search (NAS) job.
      "searchTrials": [ # Output only. List of NasTrials that were started as part of search stage.
        { # Represents a uCAIP NasJob trial.
          "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
          "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
            "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
            "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
              { # A message representing a metric in the measurement.
                "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
                "value": 3.14, # Output only. The value for this metric.
              },
            ],
            "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
          },
          "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
          "startTime": "A String", # Output only. Time when the NasTrial was started.
          "state": "A String", # Output only. The detailed state of the NasTrial.
        },
      ],
      "trainTrials": [ # Output only. List of NasTrials that were started as part of train stage.
        { # Represents a uCAIP NasJob trial.
          "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
          "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
            "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
            "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
              { # A message representing a metric in the measurement.
                "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
                "value": 3.14, # Output only. The value for this metric.
              },
            ],
            "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
          },
          "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
          "startTime": "A String", # Output only. Time when the NasTrial was started.
          "state": "A String", # Output only. The detailed state of the NasTrial.
        },
      ],
    },
  },
  "nasJobSpec": { # Represents the spec of a NasJob. # Required. The specification of a NasJob.
    "multiTrialAlgorithmSpec": { # The spec of multi-trial Neural Architecture Search (NAS). # The spec of multi-trial algorithms.
      "metric": { # Represents a metric to optimize. # Metric specs for the NAS job. Validation for this field is done at `multi_trial_algorithm_spec` field.
        "goal": "A String", # Required. The optimization goal of the metric.
        "metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces.
      },
      "multiTrialAlgorithm": "A String", # The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to `REINFORCEMENT_LEARNING`.
      "searchTrialSpec": { # Represent spec for search trials. # Required. Spec for search trials.
        "maxFailedTrialCount": 42, # The number of failed trials that need to be seen before failing the NasJob. If set to 0, Vertex AI decides how many trials must fail before the whole job fails.
        "maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
        "maxTrialCount": 42, # Required. The maximum number of Neural Architecture Search (NAS) trials to run.
        "searchTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a search trial job. The same spec applies to all search trials.
          "baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
            "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
          },
          "enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
          "enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
          "experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
          "experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
          "models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
            "A String",
          ],
          "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
          "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
          "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
          "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
            "A String",
          ],
          "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
            "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
            "maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
            "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
            "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
            "timeout": "A String", # The maximum job running time. The default is 7 days.
          },
          "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
          "tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
          "workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
            { # Represents the spec of a worker pool in a job.
              "containerSpec": { # The spec of a Container. # The custom container task.
                "args": [ # The arguments to be passed when starting the container.
                  "A String",
                ],
                "command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
                  "A String",
                ],
                "env": [ # Environment variables to be passed to the container. Maximum limit is 100.
                  { # Represents an environment variable present in a Container or Python Module.
                    "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                    "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                  },
                ],
                "imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
              },
              "diskSpec": { # Represents the spec of disk options. # Disk spec.
                "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
                "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
              },
              "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
                "acceleratorCount": 42, # The number of accelerators to attach to the machine.
                "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
                "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
                "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
                  "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
                  "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
                  "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
                    "A String",
                  ],
                },
                "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
              },
              "nfsMounts": [ # Optional. List of NFS mount spec.
                { # Represents a mount configuration for Network File System (NFS) to mount.
                  "mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
                  "path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
                  "server": "A String", # Required. IP address of the NFS server.
                },
              ],
              "pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
                "args": [ # Command line arguments to be passed to the Python task.
                  "A String",
                ],
                "env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
                  { # Represents an environment variable present in a Container or Python Module.
                    "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                    "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                  },
                ],
                "executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
                "packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
                  "A String",
                ],
                "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
              },
              "replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
            },
          ],
        },
      },
      "trainTrialSpec": { # Represent spec for train trials. # Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
        "frequency": 42, # Required. Frequency of search trials to start train stage. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
        "maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
        "trainTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a train trial job. The same spec applies to all train trials.
          "baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
            "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
          },
          "enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
          "enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
          "experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
          "experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
          "models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
            "A String",
          ],
          "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
          "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
          "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
          "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
            "A String",
          ],
          "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
            "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
            "maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
            "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
            "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
            "timeout": "A String", # The maximum job running time. The default is 7 days.
          },
          "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
          "tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
          "workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
            { # Represents the spec of a worker pool in a job.
              "containerSpec": { # The spec of a Container. # The custom container task.
                "args": [ # The arguments to be passed when starting the container.
                  "A String",
                ],
                "command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
                  "A String",
                ],
                "env": [ # Environment variables to be passed to the container. Maximum limit is 100.
                  { # Represents an environment variable present in a Container or Python Module.
                    "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                    "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                  },
                ],
                "imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
              },
              "diskSpec": { # Represents the spec of disk options. # Disk spec.
                "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
                "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
              },
              "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
                "acceleratorCount": 42, # The number of accelerators to attach to the machine.
                "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
                "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
                "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
                  "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
                  "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
                  "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
                    "A String",
                  ],
                },
                "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
              },
              "nfsMounts": [ # Optional. List of NFS mount spec.
                { # Represents a mount configuration for Network File System (NFS) to mount.
                  "mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
                  "path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
                  "server": "A String", # Required. IP address of the NFS server.
                },
              ],
              "pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
                "args": [ # Command line arguments to be passed to the Python task.
                  "A String",
                ],
                "env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
                  { # Represents an environment variable present in a Container or Python Module.
                    "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                    "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                  },
                ],
                "executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
                "packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
                  "A String",
                ],
                "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
              },
              "replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
            },
          ],
        },
      },
    },
    "resumeNasJobId": "A String", # The ID of the existing NasJob in the same Project and Location which will be used to resume search. search_space_spec and nas_algorithm_spec are obtained from previous NasJob hence should not provide them again for this NasJob.
    "searchSpaceSpec": "A String", # It defines the search space for Neural Architecture Search (NAS).
  },
  "satisfiesPzi": True or False, # Output only. Reserved for future use.
  "satisfiesPzs": True or False, # Output only. Reserved for future use.
  "startTime": "A String", # Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.
  "state": "A String", # Output only. The detailed state of the job.
  "updateTime": "A String", # Output only. Time when the NasJob was most recently updated.
}

list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

Lists NasJobs in a Location.

Args:
  parent: string, Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}` (required)
  filter: string, The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
  pageSize: integer, The standard list page size.
  pageToken: string, The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.
  readMask: string, Mask specifying which fields to read.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for JobService.ListNasJobs
  "nasJobs": [ # List of NasJobs in the requested page. NasJob.nas_job_output of the jobs will not be returned.
    { # Represents a Neural Architecture Search (NAS) job.
      "createTime": "A String", # Output only. Time when the NasJob was created.
      "displayName": "A String", # Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      "enableRestrictedImageTraining": True or False, # Optional. Enable a separation of Custom model training and restricted image training for tenant project.
      "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a NasJob. If this is set, then all resources created by the NasJob will be encrypted with the provided encryption key.
        "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
      },
      "endTime": "A String", # Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
      "error": { # 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). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # 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.
      },
      "labels": { # The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
        "a_key": "A String",
      },
      "name": "A String", # Output only. Resource name of the NasJob.
      "nasJobOutput": { # Represents a uCAIP NasJob output. # Output only. Output of the NasJob.
        "multiTrialJobOutput": { # The output of a multi-trial Neural Architecture Search (NAS) jobs. # Output only. The output of this multi-trial Neural Architecture Search (NAS) job.
          "searchTrials": [ # Output only. List of NasTrials that were started as part of search stage.
            { # Represents a uCAIP NasJob trial.
              "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
              "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
                "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
                "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
                  { # A message representing a metric in the measurement.
                    "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
                    "value": 3.14, # Output only. The value for this metric.
                  },
                ],
                "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
              },
              "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
              "startTime": "A String", # Output only. Time when the NasTrial was started.
              "state": "A String", # Output only. The detailed state of the NasTrial.
            },
          ],
          "trainTrials": [ # Output only. List of NasTrials that were started as part of train stage.
            { # Represents a uCAIP NasJob trial.
              "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
              "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
                "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
                "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
                  { # A message representing a metric in the measurement.
                    "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
                    "value": 3.14, # Output only. The value for this metric.
                  },
                ],
                "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
              },
              "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
              "startTime": "A String", # Output only. Time when the NasTrial was started.
              "state": "A String", # Output only. The detailed state of the NasTrial.
            },
          ],
        },
      },
      "nasJobSpec": { # Represents the spec of a NasJob. # Required. The specification of a NasJob.
        "multiTrialAlgorithmSpec": { # The spec of multi-trial Neural Architecture Search (NAS). # The spec of multi-trial algorithms.
          "metric": { # Represents a metric to optimize. # Metric specs for the NAS job. Validation for this field is done at `multi_trial_algorithm_spec` field.
            "goal": "A String", # Required. The optimization goal of the metric.
            "metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces.
          },
          "multiTrialAlgorithm": "A String", # The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to `REINFORCEMENT_LEARNING`.
          "searchTrialSpec": { # Represent spec for search trials. # Required. Spec for search trials.
            "maxFailedTrialCount": 42, # The number of failed trials that need to be seen before failing the NasJob. If set to 0, Vertex AI decides how many trials must fail before the whole job fails.
            "maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
            "maxTrialCount": 42, # Required. The maximum number of Neural Architecture Search (NAS) trials to run.
            "searchTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a search trial job. The same spec applies to all search trials.
              "baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
                "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
              },
              "enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
              "enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
              "experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
              "experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
              "models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
                "A String",
              ],
              "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
              "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
              "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
              "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
                "A String",
              ],
              "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
                "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
                "maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
                "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
                "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
                "timeout": "A String", # The maximum job running time. The default is 7 days.
              },
              "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
              "tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
              "workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
                { # Represents the spec of a worker pool in a job.
                  "containerSpec": { # The spec of a Container. # The custom container task.
                    "args": [ # The arguments to be passed when starting the container.
                      "A String",
                    ],
                    "command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
                      "A String",
                    ],
                    "env": [ # Environment variables to be passed to the container. Maximum limit is 100.
                      { # Represents an environment variable present in a Container or Python Module.
                        "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                        "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                      },
                    ],
                    "imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
                  },
                  "diskSpec": { # Represents the spec of disk options. # Disk spec.
                    "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
                    "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
                  },
                  "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
                    "acceleratorCount": 42, # The number of accelerators to attach to the machine.
                    "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
                    "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
                    "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
                      "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
                      "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
                      "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
                        "A String",
                      ],
                    },
                    "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
                  },
                  "nfsMounts": [ # Optional. List of NFS mount spec.
                    { # Represents a mount configuration for Network File System (NFS) to mount.
                      "mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
                      "path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
                      "server": "A String", # Required. IP address of the NFS server.
                    },
                  ],
                  "pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
                    "args": [ # Command line arguments to be passed to the Python task.
                      "A String",
                    ],
                    "env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
                      { # Represents an environment variable present in a Container or Python Module.
                        "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                        "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                      },
                    ],
                    "executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
                    "packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
                      "A String",
                    ],
                    "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
                  },
                  "replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
                },
              ],
            },
          },
          "trainTrialSpec": { # Represent spec for train trials. # Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
            "frequency": 42, # Required. Frequency of search trials to start train stage. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.
            "maxParallelTrialCount": 42, # Required. The maximum number of trials to run in parallel.
            "trainTrialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a train trial job. The same spec applies to all train trials.
              "baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
                "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
              },
              "enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
              "enableWebAccess": True or False, # Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
              "experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
              "experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
              "models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
                "A String",
              ],
              "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
              "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
              "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
              "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
                "A String",
              ],
              "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
                "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
                "maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
                "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
                "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
                "timeout": "A String", # The maximum job running time. The default is 7 days.
              },
              "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
              "tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
              "workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
                { # Represents the spec of a worker pool in a job.
                  "containerSpec": { # The spec of a Container. # The custom container task.
                    "args": [ # The arguments to be passed when starting the container.
                      "A String",
                    ],
                    "command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
                      "A String",
                    ],
                    "env": [ # Environment variables to be passed to the container. Maximum limit is 100.
                      { # Represents an environment variable present in a Container or Python Module.
                        "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                        "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                      },
                    ],
                    "imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
                  },
                  "diskSpec": { # Represents the spec of disk options. # Disk spec.
                    "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
                    "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
                  },
                  "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
                    "acceleratorCount": 42, # The number of accelerators to attach to the machine.
                    "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
                    "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
                    "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
                      "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
                      "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
                      "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
                        "A String",
                      ],
                    },
                    "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
                  },
                  "nfsMounts": [ # Optional. List of NFS mount spec.
                    { # Represents a mount configuration for Network File System (NFS) to mount.
                      "mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
                      "path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
                      "server": "A String", # Required. IP address of the NFS server.
                    },
                  ],
                  "pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
                    "args": [ # Command line arguments to be passed to the Python task.
                      "A String",
                    ],
                    "env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
                      { # Represents an environment variable present in a Container or Python Module.
                        "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                        "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                      },
                    ],
                    "executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
                    "packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
                      "A String",
                    ],
                    "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
                  },
                  "replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
                },
              ],
            },
          },
        },
        "resumeNasJobId": "A String", # The ID of the existing NasJob in the same Project and Location which will be used to resume search. search_space_spec and nas_algorithm_spec are obtained from previous NasJob hence should not provide them again for this NasJob.
        "searchSpaceSpec": "A String", # It defines the search space for Neural Architecture Search (NAS).
      },
      "satisfiesPzi": True or False, # Output only. Reserved for future use.
      "satisfiesPzs": True or False, # Output only. Reserved for future use.
      "startTime": "A String", # Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.
      "state": "A String", # Output only. The detailed state of the job.
      "updateTime": "A String", # Output only. Time when the NasJob was most recently updated.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListNasJobsRequest.page_token to obtain that page.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

Vertex AI API . projects . locations . nasJobs

Instance Methods

Method Details