1.0.0-beta87 (latest) 1.0.0-beta86

    public sealed class CustomJobSpec : IMessage<CustomJobSpec>, IEquatable<CustomJobSpec>, IDeepCloneable<CustomJobSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1beta1 API class CustomJobSpec.

Represents the spec of a CustomJob.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> CustomJobSpec

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[CustomJobSpec](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[CustomJobSpec](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[CustomJobSpec](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.AIPlatform.V1Beta1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)

## Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

## Constructors

### CustomJobSpec()

    public CustomJobSpec()

### CustomJobSpec(CustomJobSpec)

    public CustomJobSpec(CustomJobSpec other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec` |

## Properties

### BaseOutputDirectory

    public GcsDestination BaseOutputDirectory { get; set; }

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\]\[google.cloud.aiplatform.v1beta1.Trial.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 = `<base_output_directory>/model/`
- AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
- AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

  For CustomJob backing a Trial of HyperparameterTuningJob:
- AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`

- AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
- AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.GcsDestination` |   |

### EnableDashboardAccess

    public bool EnableDashboardAccess { get; set; }

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\]\[google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris\]
or
\[Trial.web_access_uris\]\[google.cloud.aiplatform.v1beta1.Trial.web_access_uris\]
(within
\[HyperparameterTuningJob.trials\]\[google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials\]).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### EnableWebAccess

    public bool EnableWebAccess { get; set; }

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\]\[google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris\]
or
\[Trial.web_access_uris\]\[google.cloud.aiplatform.v1beta1.Trial.web_access_uris\]
(within
\[HyperparameterTuningJob.trials\]\[google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials\]).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Experiment

    public string Experiment { get; set; }

Optional. The Experiment associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ExperimentAsContextName

    public ContextName ExperimentAsContextName { get; set; }

[ContextName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ContextName)-typed view over the [Experiment](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec#Google_Cloud_AIPlatform_V1Beta1_CustomJobSpec_Experiment) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ContextName` |   |

### ExperimentRun

    public string ExperimentRun { get; set; }

Optional. The Experiment Run associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ExperimentRunAsContextName

    public ContextName ExperimentRunAsContextName { get; set; }

[ContextName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ContextName)-typed view over the [ExperimentRun](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec#Google_Cloud_AIPlatform_V1Beta1_CustomJobSpec_ExperimentRun) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ContextName` |   |

### Models

    public RepeatedField<string> Models { get; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### ModelsAsModelNames

    public ResourceNameList<ModelName> ModelsAsModelNames { get; }

[ModelName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ModelName)-typed view over the [Models](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec#Google_Cloud_AIPlatform_V1Beta1_CustomJobSpec_Models) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNameList-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ModelName` |   |

### Network

    public string Network { get; set; }

Optional. The full name of the Compute Engine
[network](https://docs.cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the Job
should be peered. For example, `projects/12345/global/networks/myVPC`.
[Format](https://docs.cloud.google.com/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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### NetworkAsNetworkName

    public NetworkName NetworkAsNetworkName { get; set; }

[NetworkName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.NetworkName)-typed view over the [Network](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec#Google_Cloud_AIPlatform_V1Beta1_CustomJobSpec_Network) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.NetworkName` |   |

### PersistentResourceId

    public string PersistentResourceId { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### PersistentResourceIdAsPersistentResourceName

    public PersistentResourceName PersistentResourceIdAsPersistentResourceName { get; set; }

[PersistentResourceName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.PersistentResourceName)-typed view over the [PersistentResourceId](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec#Google_Cloud_AIPlatform_V1Beta1_CustomJobSpec_PersistentResourceId) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.PersistentResourceName` |   |

### ProtectedArtifactLocationId

    public string ProtectedArtifactLocationId { get; set; }

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>

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### PscInterfaceConfig

    public PscInterfaceConfig PscInterfaceConfig { get; set; }

Optional. Configuration for PSC-I for CustomJob.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.PscInterfaceConfig` |   |

### ReservedIpRanges

    public RepeatedField<string> ReservedIpRanges { get; }

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'\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Scheduling

    public Scheduling Scheduling { get; set; }

Scheduling options for a CustomJob.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Scheduling` |   |

### ServiceAccount

    public string ServiceAccount { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Tensorboard

    public string Tensorboard { get; set; }

Optional. The name of a Vertex AI
\[Tensorboard\]\[google.cloud.aiplatform.v1beta1.Tensorboard\] resource to
which this CustomJob will upload Tensorboard logs. Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### TensorboardAsTensorboardName

    public TensorboardName TensorboardAsTensorboardName { get; set; }

[TensorboardName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.TensorboardName)-typed view over the [Tensorboard](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.CustomJobSpec#Google_Cloud_AIPlatform_V1Beta1_CustomJobSpec_Tensorboard) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.TensorboardName` |   |

### WorkerPoolSpecs

    public RepeatedField<WorkerPoolSpec> WorkerPoolSpecs { get; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.WorkerPoolSpec` |   |