Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.aiplatform/v1beta1.getCustomJob
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets a CustomJob.
Using getCustomJob
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCustomJob(args: GetCustomJobArgs, opts?: InvokeOptions): Promise<GetCustomJobResult>
function getCustomJobOutput(args: GetCustomJobOutputArgs, opts?: InvokeOptions): Output<GetCustomJobResult>
def get_custom_job(custom_job_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCustomJobResult
def get_custom_job_output(custom_job_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCustomJobResult]
func LookupCustomJob(ctx *Context, args *LookupCustomJobArgs, opts ...InvokeOption) (*LookupCustomJobResult, error)
func LookupCustomJobOutput(ctx *Context, args *LookupCustomJobOutputArgs, opts ...InvokeOption) LookupCustomJobResultOutput
> Note: This function is named LookupCustomJob
in the Go SDK.
public static class GetCustomJob
{
public static Task<GetCustomJobResult> InvokeAsync(GetCustomJobArgs args, InvokeOptions? opts = null)
public static Output<GetCustomJobResult> Invoke(GetCustomJobInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCustomJobResult> getCustomJob(GetCustomJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:aiplatform/v1beta1:getCustomJob
arguments:
# arguments dictionary
The following arguments are supported:
- Custom
Job stringId - Location string
- Project string
- Custom
Job stringId - Location string
- Project string
- custom
Job StringId - location String
- project String
- custom
Job stringId - location string
- project string
- custom_
job_ strid - location str
- project str
- custom
Job StringId - location String
- project String
getCustomJob Result
The following output properties are available:
- Create
Time string - Time when the CustomJob was created.
- Display
Name string - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Encryption
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Encryption Spec Response - Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
- End
Time string - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED
,JOB_STATE_FAILED
,JOB_STATE_CANCELLED
. - Error
Pulumi.
Google Native. Aiplatform. V1Beta1. Outputs. Google Rpc Status Response - Only populated when job's state is
JOB_STATE_FAILED
orJOB_STATE_CANCELLED
. - Job
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Custom Job Spec Response - Job spec.
- Labels Dictionary<string, string>
- The labels with user-defined metadata to organize CustomJobs. 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.
- Name string
- Resource name of a CustomJob.
- Start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING
state. - State string
- The detailed state of the job.
- Update
Time string - Time when the CustomJob was most recently updated.
- Web
Access Dictionary<string, string>Uris - URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is
true
. The keys are names of each node in the training job; for example,workerpool0-0
for the primary node,workerpool1-0
for the first node in the second worker pool, andworkerpool1-1
for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
- Create
Time string - Time when the CustomJob was created.
- Display
Name string - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
- End
Time string - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED
,JOB_STATE_FAILED
,JOB_STATE_CANCELLED
. - Error
Google
Rpc Status Response - Only populated when job's state is
JOB_STATE_FAILED
orJOB_STATE_CANCELLED
. - Job
Spec GoogleCloud Aiplatform V1beta1Custom Job Spec Response - Job spec.
- Labels map[string]string
- The labels with user-defined metadata to organize CustomJobs. 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.
- Name string
- Resource name of a CustomJob.
- Start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING
state. - State string
- The detailed state of the job.
- Update
Time string - Time when the CustomJob was most recently updated.
- Web
Access map[string]stringUris - URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is
true
. The keys are names of each node in the training job; for example,workerpool0-0
for the primary node,workerpool1-0
for the first node in the second worker pool, andworkerpool1-1
for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
- create
Time String - Time when the CustomJob was created.
- display
Name String - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
- end
Time String - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED
,JOB_STATE_FAILED
,JOB_STATE_CANCELLED
. - error
Google
Rpc Status Response - Only populated when job's state is
JOB_STATE_FAILED
orJOB_STATE_CANCELLED
. - job
Spec GoogleCloud Aiplatform V1beta1Custom Job Spec Response - Job spec.
- labels Map<String,String>
- The labels with user-defined metadata to organize CustomJobs. 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.
- name String
- Resource name of a CustomJob.
- start
Time String - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING
state. - state String
- The detailed state of the job.
- update
Time String - Time when the CustomJob was most recently updated.
- web
Access Map<String,String>Uris - URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is
true
. The keys are names of each node in the training job; for example,workerpool0-0
for the primary node,workerpool1-0
for the first node in the second worker pool, andworkerpool1-1
for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
- create
Time string - Time when the CustomJob was created.
- display
Name string - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
- end
Time string - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED
,JOB_STATE_FAILED
,JOB_STATE_CANCELLED
. - error
Google
Rpc Status Response - Only populated when job's state is
JOB_STATE_FAILED
orJOB_STATE_CANCELLED
. - job
Spec GoogleCloud Aiplatform V1beta1Custom Job Spec Response - Job spec.
- labels {[key: string]: string}
- The labels with user-defined metadata to organize CustomJobs. 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.
- name string
- Resource name of a CustomJob.
- start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING
state. - state string
- The detailed state of the job.
- update
Time string - Time when the CustomJob was most recently updated.
- web
Access {[key: string]: string}Uris - URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is
true
. The keys are names of each node in the training job; for example,workerpool0-0
for the primary node,workerpool1-0
for the first node in the second worker pool, andworkerpool1-1
for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
- create_
time str - Time when the CustomJob was created.
- display_
name str - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption_
spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
- end_
time str - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED
,JOB_STATE_FAILED
,JOB_STATE_CANCELLED
. - error
Google
Rpc Status Response - Only populated when job's state is
JOB_STATE_FAILED
orJOB_STATE_CANCELLED
. - job_
spec GoogleCloud Aiplatform V1beta1Custom Job Spec Response - Job spec.
- labels Mapping[str, str]
- The labels with user-defined metadata to organize CustomJobs. 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.
- name str
- Resource name of a CustomJob.
- start_
time str - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING
state. - state str
- The detailed state of the job.
- update_
time str - Time when the CustomJob was most recently updated.
- web_
access_ Mapping[str, str]uris - URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is
true
. The keys are names of each node in the training job; for example,workerpool0-0
for the primary node,workerpool1-0
for the first node in the second worker pool, andworkerpool1-1
for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
- create
Time String - Time when the CustomJob was created.
- display
Name String - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec Property Map - Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
- end
Time String - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED
,JOB_STATE_FAILED
,JOB_STATE_CANCELLED
. - error Property Map
- Only populated when job's state is
JOB_STATE_FAILED
orJOB_STATE_CANCELLED
. - job
Spec Property Map - Job spec.
- labels Map<String>
- The labels with user-defined metadata to organize CustomJobs. 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.
- name String
- Resource name of a CustomJob.
- start
Time String - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING
state. - state String
- The detailed state of the job.
- update
Time String - Time when the CustomJob was most recently updated.
- web
Access Map<String>Uris - URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is
true
. The keys are names of each node in the training job; for example,workerpool0-0
for the primary node,workerpool1-0
for the first node in the second worker pool, andworkerpool1-1
for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
Supporting Types
GoogleCloudAiplatformV1beta1ContainerSpecResponse
- Args List<string>
- The arguments to be passed when starting the container.
- Command List<string>
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- Env
List<Pulumi.
Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Env Var Response> - Environment variables to be passed to the container. Maximum limit is 100.
- Image
Uri string - The URI of a container image in the Container Registry that is to be run on each worker replica.
- Args []string
- The arguments to be passed when starting the container.
- Command []string
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- Env
[]Google
Cloud Aiplatform V1beta1Env Var Response - Environment variables to be passed to the container. Maximum limit is 100.
- Image
Uri string - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args List<String>
- The arguments to be passed when starting the container.
- command List<String>
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- env
List<Google
Cloud Aiplatform V1beta1Env Var Response> - Environment variables to be passed to the container. Maximum limit is 100.
- image
Uri String - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args string[]
- The arguments to be passed when starting the container.
- command string[]
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- env
Google
Cloud Aiplatform V1beta1Env Var Response[] - Environment variables to be passed to the container. Maximum limit is 100.
- image
Uri string - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args Sequence[str]
- The arguments to be passed when starting the container.
- command Sequence[str]
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- env
Sequence[Google
Cloud Aiplatform V1beta1Env Var Response] - Environment variables to be passed to the container. Maximum limit is 100.
- image_
uri str - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args List<String>
- The arguments to be passed when starting the container.
- command List<String>
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- env List<Property Map>
- Environment variables to be passed to the container. Maximum limit is 100.
- image
Uri String - The URI of a container image in the Container Registry that is to be run on each worker replica.
GoogleCloudAiplatformV1beta1CustomJobSpecResponse
- Base
Output Pulumi.Directory Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Gcs Destination Response - 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/
- Enable
Dashboard boolAccess - 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). - Enable
Web boolAccess - Optional. Whether you want Vertex AI to enable interactive shell access 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 string
- Optional. The Experiment associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}
- Experiment
Run string - Optional. The Experiment Run associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}
- Network string
- Optional. The full name of the Compute Engine network to which the Job should be peered. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the job is not peered with any network. - Persistent
Resource stringId - 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.
- Protected
Artifact stringLocation Id - 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
- Reserved
Ip List<string>Ranges - 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'].
- Scheduling
Pulumi.
Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Scheduling Response - Scheduling options for a CustomJob.
- Service
Account 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 for the CustomJob's project is used.
- Tensorboard 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}
- Worker
Pool List<Pulumi.Specs Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Worker Pool Spec Response> - 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.
- Base
Output GoogleDirectory Cloud Aiplatform V1beta1Gcs Destination Response - 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/
- Enable
Dashboard boolAccess - 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). - Enable
Web boolAccess - Optional. Whether you want Vertex AI to enable interactive shell access 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 string
- Optional. The Experiment associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}
- Experiment
Run string - Optional. The Experiment Run associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}
- Network string
- Optional. The full name of the Compute Engine network to which the Job should be peered. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the job is not peered with any network. - Persistent
Resource stringId - 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.
- Protected
Artifact stringLocation Id - 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
- Reserved
Ip []stringRanges - 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'].
- Scheduling
Google
Cloud Aiplatform V1beta1Scheduling Response - Scheduling options for a CustomJob.
- Service
Account 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 for the CustomJob's project is used.
- Tensorboard 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}
- Worker
Pool []GoogleSpecs Cloud Aiplatform V1beta1Worker Pool Spec Response - 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.
- base
Output GoogleDirectory Cloud Aiplatform V1beta1Gcs Destination Response - 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/
- enable
Dashboard BooleanAccess - 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). - enable
Web BooleanAccess - Optional. Whether you want Vertex AI to enable interactive shell access 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 String
- Optional. The Experiment associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}
- experiment
Run String - Optional. The Experiment Run associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}
- network String
- Optional. The full name of the Compute Engine network to which the Job should be peered. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the job is not peered with any network. - persistent
Resource StringId - 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.
- protected
Artifact StringLocation Id - 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
- reserved
Ip List<String>Ranges - 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'].
- scheduling
Google
Cloud Aiplatform V1beta1Scheduling Response - Scheduling options for a CustomJob.
- service
Account 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 for the CustomJob's project is used.
- tensorboard 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}
- worker
Pool List<GoogleSpecs Cloud Aiplatform V1beta1Worker Pool Spec Response> - 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.
- base
Output GoogleDirectory Cloud Aiplatform V1beta1Gcs Destination Response - 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/
- enable
Dashboard booleanAccess - 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). - enable
Web booleanAccess - Optional. Whether you want Vertex AI to enable interactive shell access 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 string
- Optional. The Experiment associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}
- experiment
Run string - Optional. The Experiment Run associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}
- network string
- Optional. The full name of the Compute Engine network to which the Job should be peered. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the job is not peered with any network. - persistent
Resource stringId - 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.
- protected
Artifact stringLocation Id - 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
- reserved
Ip string[]Ranges - 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'].
- scheduling
Google
Cloud Aiplatform V1beta1Scheduling Response - Scheduling options for a CustomJob.
- service
Account 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 for the CustomJob's project is used.
- tensorboard 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}
- worker
Pool GoogleSpecs Cloud Aiplatform V1beta1Worker Pool Spec Response[] - 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.
- base_
output_ Googledirectory Cloud Aiplatform V1beta1Gcs Destination Response - 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/
- enable_
dashboard_ boolaccess - 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). - enable_
web_ boolaccess - Optional. Whether you want Vertex AI to enable interactive shell access 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 str
- Optional. The Experiment associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}
- experiment_
run str - Optional. The Experiment Run associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}
- network str
- Optional. The full name of the Compute Engine network to which the Job should be peered. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the job is not peered with any network. - persistent_
resource_ strid - 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.
- protected_
artifact_ strlocation_ id - 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
- reserved_
ip_ Sequence[str]ranges - 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'].
- scheduling
Google
Cloud Aiplatform V1beta1Scheduling Response - Scheduling options for a CustomJob.
- service_
account str - 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 for the CustomJob's project is used.
- tensorboard str
- Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
- worker_
pool_ Sequence[Googlespecs Cloud Aiplatform V1beta1Worker Pool Spec Response] - 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.
- base
Output Property MapDirectory - 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/
- enable
Dashboard BooleanAccess - 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). - enable
Web BooleanAccess - Optional. Whether you want Vertex AI to enable interactive shell access 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 String
- Optional. The Experiment associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}
- experiment
Run String - Optional. The Experiment Run associated with this job. Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}
- network String
- Optional. The full name of the Compute Engine network to which the Job should be peered. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the job is not peered with any network. - persistent
Resource StringId - 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.
- protected
Artifact StringLocation Id - 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
- reserved
Ip List<String>Ranges - 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'].
- scheduling Property Map
- Scheduling options for a CustomJob.
- service
Account 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 for the CustomJob's project is used.
- tensorboard 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}
- worker
Pool List<Property Map>Specs - 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.
GoogleCloudAiplatformV1beta1DiskSpecResponse
- Boot
Disk intSize Gb - Size in GB of the boot disk (default is 100GB).
- Boot
Disk stringType - 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).
- Boot
Disk intSize Gb - Size in GB of the boot disk (default is 100GB).
- Boot
Disk stringType - 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).
- boot
Disk IntegerSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk StringType - 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).
- boot
Disk numberSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk stringType - 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).
- boot_
disk_ intsize_ gb - Size in GB of the boot disk (default is 100GB).
- boot_
disk_ strtype - 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).
- boot
Disk NumberSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk StringType - 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).
GoogleCloudAiplatformV1beta1EncryptionSpecResponse
- Kms
Key stringName - 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.
- Kms
Key stringName - 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.
- kms
Key StringName - 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.
- kms
Key stringName - 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.
- kms_
key_ strname - 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.
- kms
Key StringName - 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.
GoogleCloudAiplatformV1beta1EnvVarResponse
- Name string
- Name of the environment variable. Must be a valid C identifier.
- Value string
- 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.
- Name string
- Name of the environment variable. Must be a valid C identifier.
- Value string
- 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.
- name String
- Name of the environment variable. Must be a valid C identifier.
- value String
- 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.
- name string
- Name of the environment variable. Must be a valid C identifier.
- value string
- 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.
- name str
- Name of the environment variable. Must be a valid C identifier.
- value str
- 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.
- name String
- Name of the environment variable. Must be a valid C identifier.
- value String
- 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.
GoogleCloudAiplatformV1beta1GcsDestinationResponse
- Output
Uri stringPrefix - 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.
- Output
Uri stringPrefix - 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.
- output
Uri StringPrefix - 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.
- output
Uri stringPrefix - 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.
- output_
uri_ strprefix - 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.
- output
Uri StringPrefix - 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.
GoogleCloudAiplatformV1beta1MachineSpecResponse
- Accelerator
Count int - The number of accelerators to attach to the machine.
- Accelerator
Type string - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- Machine
Type string - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. 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. - Tpu
Topology string - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- Accelerator
Count int - The number of accelerators to attach to the machine.
- Accelerator
Type string - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- Machine
Type string - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. 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. - Tpu
Topology string - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator
Count Integer - The number of accelerators to attach to the machine.
- accelerator
Type String - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine
Type String - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. 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. - tpu
Topology String - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator
Count number - The number of accelerators to attach to the machine.
- accelerator
Type string - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine
Type string - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. 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. - tpu
Topology string - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator_
count int - The number of accelerators to attach to the machine.
- accelerator_
type str - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine_
type str - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. 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. - tpu_
topology str - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator
Count Number - The number of accelerators to attach to the machine.
- accelerator
Type String - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine
Type String - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. 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. - tpu
Topology String - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
GoogleCloudAiplatformV1beta1NfsMountResponse
- Mount
Point string - Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
- Path string
- 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 string
- IP address of the NFS server.
- Mount
Point string - Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
- Path string
- 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 string
- IP address of the NFS server.
- mount
Point String - Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
- path String
- 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 String
- IP address of the NFS server.
- mount
Point string - Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
- path string
- 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 string
- IP address of the NFS server.
- mount_
point str - Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
- path str
- 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 str
- IP address of the NFS server.
- mount
Point String - Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
- path String
- 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 String
- IP address of the NFS server.
GoogleCloudAiplatformV1beta1PythonPackageSpecResponse
- Args List<string>
- Command line arguments to be passed to the Python task.
- Env
List<Pulumi.
Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Env Var Response> - Environment variables to be passed to the python module. Maximum limit is 100.
- Executor
Image stringUri - 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. You must use an image from this list.
- Package
Uris List<string> - 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.
- Python
Module string - The Python module name to run after installing the packages.
- Args []string
- Command line arguments to be passed to the Python task.
- Env
[]Google
Cloud Aiplatform V1beta1Env Var Response - Environment variables to be passed to the python module. Maximum limit is 100.
- Executor
Image stringUri - 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. You must use an image from this list.
- Package
Uris []string - 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.
- Python
Module string - The Python module name to run after installing the packages.
- args List<String>
- Command line arguments to be passed to the Python task.
- env
List<Google
Cloud Aiplatform V1beta1Env Var Response> - Environment variables to be passed to the python module. Maximum limit is 100.
- executor
Image StringUri - 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. You must use an image from this list.
- package
Uris List<String> - 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.
- python
Module String - The Python module name to run after installing the packages.
- args string[]
- Command line arguments to be passed to the Python task.
- env
Google
Cloud Aiplatform V1beta1Env Var Response[] - Environment variables to be passed to the python module. Maximum limit is 100.
- executor
Image stringUri - 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. You must use an image from this list.
- package
Uris string[] - 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.
- python
Module string - The Python module name to run after installing the packages.
- args Sequence[str]
- Command line arguments to be passed to the Python task.
- env
Sequence[Google
Cloud Aiplatform V1beta1Env Var Response] - Environment variables to be passed to the python module. Maximum limit is 100.
- executor_
image_ struri - 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. You must use an image from this list.
- package_
uris Sequence[str] - 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.
- python_
module str - The Python module name to run after installing the packages.
- args List<String>
- Command line arguments to be passed to the Python task.
- env List<Property Map>
- Environment variables to be passed to the python module. Maximum limit is 100.
- executor
Image StringUri - 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. You must use an image from this list.
- package
Uris List<String> - 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.
- python
Module String - The Python module name to run after installing the packages.
GoogleCloudAiplatformV1beta1SchedulingResponse
- Disable
Retries bool - 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. - Restart
Job boolOn Worker Restart - 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.
- Timeout string
- The maximum job running time. The default is 7 days.
- Disable
Retries bool - 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. - Restart
Job boolOn Worker Restart - 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.
- Timeout string
- The maximum job running time. The default is 7 days.
- disable
Retries Boolean - 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. - restart
Job BooleanOn Worker Restart - 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.
- timeout String
- The maximum job running time. The default is 7 days.
- disable
Retries boolean - 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. - restart
Job booleanOn Worker Restart - 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.
- timeout string
- The maximum job running time. The default is 7 days.
- disable_
retries bool - 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. - restart_
job_ boolon_ worker_ restart - 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.
- timeout str
- The maximum job running time. The default is 7 days.
- disable
Retries Boolean - 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. - restart
Job BooleanOn Worker Restart - 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.
- timeout String
- The maximum job running time. The default is 7 days.
GoogleCloudAiplatformV1beta1WorkerPoolSpecResponse
- Container
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Container Spec Response - The custom container task.
- Disk
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Disk Spec Response - Disk spec.
- Machine
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Machine Spec Response - Optional. Immutable. The specification of a single machine.
- Nfs
Mounts List<Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Nfs Mount Response> - Optional. List of NFS mount spec.
- Python
Package Pulumi.Spec Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Python Package Spec Response - The Python packaged task.
- Replica
Count string - Optional. The number of worker replicas to use for this worker pool.
- Container
Spec GoogleCloud Aiplatform V1beta1Container Spec Response - The custom container task.
- Disk
Spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Disk spec.
- Machine
Spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Optional. Immutable. The specification of a single machine.
- Nfs
Mounts []GoogleCloud Aiplatform V1beta1Nfs Mount Response - Optional. List of NFS mount spec.
- Python
Package GoogleSpec Cloud Aiplatform V1beta1Python Package Spec Response - The Python packaged task.
- Replica
Count string - Optional. The number of worker replicas to use for this worker pool.
- container
Spec GoogleCloud Aiplatform V1beta1Container Spec Response - The custom container task.
- disk
Spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Disk spec.
- machine
Spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Optional. Immutable. The specification of a single machine.
- nfs
Mounts List<GoogleCloud Aiplatform V1beta1Nfs Mount Response> - Optional. List of NFS mount spec.
- python
Package GoogleSpec Cloud Aiplatform V1beta1Python Package Spec Response - The Python packaged task.
- replica
Count String - Optional. The number of worker replicas to use for this worker pool.
- container
Spec GoogleCloud Aiplatform V1beta1Container Spec Response - The custom container task.
- disk
Spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Disk spec.
- machine
Spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Optional. Immutable. The specification of a single machine.
- nfs
Mounts GoogleCloud Aiplatform V1beta1Nfs Mount Response[] - Optional. List of NFS mount spec.
- python
Package GoogleSpec Cloud Aiplatform V1beta1Python Package Spec Response - The Python packaged task.
- replica
Count string - Optional. The number of worker replicas to use for this worker pool.
- container_
spec GoogleCloud Aiplatform V1beta1Container Spec Response - The custom container task.
- disk_
spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Disk spec.
- machine_
spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Optional. Immutable. The specification of a single machine.
- nfs_
mounts Sequence[GoogleCloud Aiplatform V1beta1Nfs Mount Response] - Optional. List of NFS mount spec.
- python_
package_ Googlespec Cloud Aiplatform V1beta1Python Package Spec Response - The Python packaged task.
- replica_
count str - Optional. The number of worker replicas to use for this worker pool.
- container
Spec Property Map - The custom container task.
- disk
Spec Property Map - Disk spec.
- machine
Spec Property Map - Optional. Immutable. The specification of a single machine.
- nfs
Mounts List<Property Map> - Optional. List of NFS mount spec.
- python
Package Property MapSpec - The Python packaged task.
- replica
Count String - Optional. The number of worker replicas to use for this worker pool.
GoogleRpcStatusResponse
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<Immutable
Dictionary<string, string>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message 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.
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details []map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message 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.
- code Integer
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message 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.
- code number
- The status code, which should be an enum value of google.rpc.Code.
- details {[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message 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.
- code int
- The status code, which should be an enum value of google.rpc.Code.
- details Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message str
- 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.
- code Number
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message 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.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi