gcp_aiplatform_notebook_execution_job

ancestors

Type: UNORDERED_LIST_STRING

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. Timestamp when this NotebookExecutionJob was created.

custom_environment_spec

Type: STRUCT
Provider name: customEnvironmentSpec
Description: The custom compute configuration for an execution job.

• machine_spec
  Type: STRUCT
  Provider name: machineSpec
  Description: The specification of a single machine for the execution job.
  
  • accelerator_count
    Type: INT32
    Provider name: acceleratorCount
    Description: The number of accelerators to attach to the machine.
    
  • accelerator_type
    Type: STRING
    Provider name: acceleratorType
    Description: Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
    Possible values:
    
    • ACCELERATOR_TYPE_UNSPECIFIED - Unspecified accelerator type, which means no accelerator.
      
    • NVIDIA_TESLA_K80 - Deprecated: Nvidia Tesla K80 GPU has reached end of support, see https://cloud.google.com/compute/docs/eol/k80-eol.
      
    • NVIDIA_TESLA_P100 - Nvidia Tesla P100 GPU.
      
    • NVIDIA_TESLA_V100 - Nvidia Tesla V100 GPU.
      
    • NVIDIA_TESLA_P4 - Nvidia Tesla P4 GPU.
      
    • NVIDIA_TESLA_T4 - Nvidia Tesla T4 GPU.
      
    • NVIDIA_TESLA_A100 - Nvidia Tesla A100 GPU.
      
    • NVIDIA_A100_80GB - Nvidia A100 80GB GPU.
      
    • NVIDIA_L4 - Nvidia L4 GPU.
      
    • NVIDIA_H100_80GB - Nvidia H100 80Gb GPU.
      
    • NVIDIA_H100_MEGA_80GB - Nvidia H100 Mega 80Gb GPU.
      
    • NVIDIA_H200_141GB - Nvidia H200 141Gb GPU.
      
    • TPU_V2 - TPU v2.
      
    • TPU_V3 - TPU v3.
      
    • TPU_V4_POD - TPU v4.
      
    • TPU_V5_LITEPOD - TPU v5.
      
  • machine_type
    Type: STRING
    Provider name: machineType
    Description: 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.
    
  • reservation_affinity
    Type: STRUCT
    Provider name: reservationAffinity
    Description: Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
    
    • key
      Type: STRING
      Provider name: key
      Description: 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.
      
    • reservation_affinity_type
      Type: STRING
      Provider name: reservationAffinityType
      Description: Required. Specifies the reservation affinity type.
      Possible values:
      
      • TYPE_UNSPECIFIED - Default value. This should not be used.
        
      • NO_RESERVATION - Do not consume from any reserved capacity, only use on-demand.
        
      • ANY_RESERVATION - Consume any reservation available, falling back to on-demand.
        
      • SPECIFIC_RESERVATION - Consume from a specific reservation. When chosen, the reservation must be identified via the key and values fields.
        
    • values
      Type: UNORDERED_LIST_STRING
      Provider name: values
      Description: Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
      
  • tpu_topology
    Type: STRING
    Provider name: tpuTopology
    Description: Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: “2x2x1”).
    
• network_spec
  Type: STRUCT
  Provider name: networkSpec
  Description: The network configuration to use for the execution job.
  
  • enable_internet_access
    Type: BOOLEAN
    Provider name: enableInternetAccess
    Description: Whether to enable public internet access. Default false.
    
  • network
    Type: STRING
    Provider name: network
    Description: The full name of the Google Compute Engine network
    
  • subnetwork
    Type: STRING
    Provider name: subnetwork
    Description: The name of the subnet that this instance is in. Format: projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}
    
• persistent_disk_spec
  Type: STRUCT
  Provider name: persistentDiskSpec
  Description: The specification of a persistent disk to attach for the execution job.
  
  • disk_size_gb
    Type: INT64
    Provider name: diskSizeGb
    Description: Size in GB of the disk (default is 100GB).
    
  • disk_type
    Type: STRING
    Provider name: diskType
    Description: Type of the disk (default is “pd-standard”). Valid values: “pd-ssd” (Persistent Disk Solid State Drive) “pd-standard” (Persistent Disk Hard Disk Drive) “pd-balanced” (Balanced Persistent Disk) “pd-extreme” (Extreme Persistent Disk)
    

dataform_repository_source

Type: STRUCT
Provider name: dataformRepositorySource
Description: The Dataform Repository pointing to a single file notebook repository.

• commit_sha
  Type: STRING
  Provider name: commitSha
  Description: The commit SHA to read repository with. If unset, the file will be read at HEAD.
  
• dataform_repository_resource_name
  Type: STRING
  Provider name: dataformRepositoryResourceName
  Description: The resource name of the Dataform Repository. Format: projects/{project_id}/locations/{location}/repositories/{repository_id}
  

direct_notebook_source

Type: STRUCT
Provider name: directNotebookSource
Description: The contents of an input notebook file.

encryption_spec

Type: STRUCT
Provider name: encryptionSpec
Description: Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

• kms_key_name
  Type: STRING
  Provider name: kmsKeyName
  Description: 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.
  

execution_timeout

Type: STRING
Provider name: executionTimeout
Description: Max running time of the execution job in seconds (default 86400s / 24 hrs).

execution_user

Type: STRING
Provider name: executionUser
Description: The user email to run the execution as. Only supported by Colab runtimes.

gcp_display_name

Type: STRING
Provider name: displayName
Description: The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

gcp_status

Type: STRUCT
Provider name: status
Description: Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

• code
  Type: INT32
  Provider name: code
  Description: The status code, which should be an enum value of google.rpc.Code.
  
• message
  Type: STRING
  Provider name: message
  Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  

gcs_notebook_source

Type: STRUCT
Provider name: gcsNotebookSource
Description: The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

• generation
  Type: STRING
  Provider name: generation
  Description: The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
  
• uri
  Type: STRING
  Provider name: uri
  Description: The Cloud Storage uri pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
  

gcs_output_uri

Type: STRING
Provider name: gcsOutputUri
Description: The Cloud Storage location to upload the result to. Format: gs://bucket-name

job_state

Type: STRING
Provider name: jobState
Description: Output only. The state of the NotebookExecutionJob.
Possible values:

• JOB_STATE_UNSPECIFIED - The job state is unspecified.
  
• JOB_STATE_QUEUED - The job has been just created or resumed and processing has not yet begun.
  
• JOB_STATE_PENDING - The service is preparing to run the job.
  
• JOB_STATE_RUNNING - The job is in progress.
  
• JOB_STATE_SUCCEEDED - The job completed successfully.
  
• JOB_STATE_FAILED - The job failed.
  
• JOB_STATE_CANCELLING - The job is being cancelled. From this state the job may only go to either JOB_STATE_SUCCEEDED, JOB_STATE_FAILED or JOB_STATE_CANCELLED.
  
• JOB_STATE_CANCELLED - The job has been cancelled.
  
• JOB_STATE_PAUSED - The job has been stopped, and can be resumed.
  
• JOB_STATE_EXPIRED - The job has expired.
  
• JOB_STATE_UPDATING - The job is being updated. Only jobs in the RUNNING state can be updated. After updating, the job goes back to the RUNNING state.
  
• JOB_STATE_PARTIALLY_SUCCEEDED - The job is partially succeeded, some results may be missing due to errors.
  

kernel_name

Type: STRING
Provider name: kernelName
Description: The name of the kernel to use during notebook execution. If unset, the default kernel is used.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

notebook_runtime_template_resource_name

Type: STRING
Provider name: notebookRuntimeTemplateResourceName
Description: The NotebookRuntimeTemplate to source compute configuration from.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

schedule_resource_name

Type: STRING
Provider name: scheduleResourceName
Description: The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

service_account

Type: STRING
Provider name: serviceAccount
Description: The service account to run the execution as.

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Timestamp when this NotebookExecutionJob was most recently updated.

workbench_runtime

Type: STRUCT
Provider name: workbenchRuntime
Description: The Workbench runtime configuration to use for the notebook execution.