Vertex AI V1 API - Module Google::Cloud::AIPlatform::V1::JobService::Paths (v0.57.0)

Reference documentation and code samples for the Vertex AI V1 API module Google::Cloud::AIPlatform::V1::JobService::Paths.

Path helper methods for the JobService API.

Extended By

Methods

#batch_prediction_job_path

def batch_prediction_job_path(project:, location:, batch_prediction_job:) -> ::String

Create a fully-qualified BatchPredictionJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Parameters
  • project (String)
  • location (String)
  • batch_prediction_job (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#context_path

def context_path(project:, location:, metadata_store:, context:) -> ::String

Create a fully-qualified Context resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/metadataStores/{metadata_store}/contexts/{context}

Parameters
  • project (String)
  • location (String)
  • metadata_store (String)
  • context (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#custom_job_path

def custom_job_path(project:, location:, custom_job:) -> ::String

Create a fully-qualified CustomJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/customJobs/{custom_job}

Parameters
  • project (String)
  • location (String)
  • custom_job (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#data_labeling_job_path

def data_labeling_job_path(project:, location:, data_labeling_job:) -> ::String

Create a fully-qualified DataLabelingJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Parameters
  • project (String)
  • location (String)
  • data_labeling_job (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#dataset_path

def dataset_path(project:, location:, dataset:) -> ::String

Create a fully-qualified Dataset resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/datasets/{dataset}

Parameters
  • project (String)
  • location (String)
  • dataset (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#endpoint_path

def endpoint_path(project:, location:, endpoint:) -> ::String
def endpoint_path(project:, location:, publisher:, model:) -> ::String

Create a fully-qualified Endpoint resource string.

Overloads 
def endpoint_path(project:, location:, endpoint:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/endpoints/{endpoint}

Parameters
  • project (String)
  • location (String)
  • endpoint (String) 
def endpoint_path(project:, location:, publisher:, model:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

Parameters
  • project (String)
  • location (String)
  • publisher (String)
  • model (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#hyperparameter_tuning_job_path

def hyperparameter_tuning_job_path(project:, location:, hyperparameter_tuning_job:) -> ::String

Create a fully-qualified HyperparameterTuningJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Parameters
  • project (String)
  • location (String)
  • hyperparameter_tuning_job (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#location_path

def location_path(project:, location:) -> ::String

Create a fully-qualified Location resource string.

The resource will be in the following format:

projects/{project}/locations/{location}

Parameters
  • project (String)
  • location (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#model_deployment_monitoring_job_path

def model_deployment_monitoring_job_path(project:, location:, model_deployment_monitoring_job:) -> ::String

Create a fully-qualified ModelDeploymentMonitoringJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Parameters
  • project (String)
  • location (String)
  • model_deployment_monitoring_job (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#model_path

def model_path(project:, location:, model:) -> ::String

Create a fully-qualified Model resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/models/{model}

Parameters
  • project (String)
  • location (String)
  • model (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#nas_job_path

def nas_job_path(project:, location:, nas_job:) -> ::String

Create a fully-qualified NasJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/nasJobs/{nas_job}

Parameters
  • project (String)
  • location (String)
  • nas_job (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#nas_trial_detail_path

def nas_trial_detail_path(project:, location:, nas_job:, nas_trial_detail:) -> ::String

Create a fully-qualified NasTrialDetail resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}

Parameters
  • project (String)
  • location (String)
  • nas_job (String)
  • nas_trial_detail (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#network_path

def network_path(project:, network:) -> ::String

Create a fully-qualified Network resource string.

The resource will be in the following format:

projects/{project}/global/networks/{network}

Parameters
  • project (String)
  • network (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#notification_channel_path

def notification_channel_path(project:, notification_channel:) -> ::String

Create a fully-qualified NotificationChannel resource string.

The resource will be in the following format:

projects/{project}/notificationChannels/{notification_channel}

Parameters
  • project (String)
  • notification_channel (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#persistent_resource_path

def persistent_resource_path(project:, location:, persistent_resource:) -> ::String

Create a fully-qualified PersistentResource resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/persistentResources/{persistent_resource}

Parameters
  • project (String)
  • location (String)
  • persistent_resource (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#reservation_path

def reservation_path(project_id_or_number:, zone:, reservation_name:) -> ::String

Create a fully-qualified Reservation resource string.

The resource will be in the following format:

projects/{project_id_or_number}/zones/{zone}/reservations/{reservation_name}

Parameters
  • project_id_or_number (String)
  • zone (String)
  • reservation_name (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#tensorboard_path

def tensorboard_path(project:, location:, tensorboard:) -> ::String

Create a fully-qualified Tensorboard resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/tensorboards/{tensorboard}

Parameters
  • project (String)
  • location (String)
  • tensorboard (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#trial_path

def trial_path(project:, location:, study:, trial:) -> ::String

Create a fully-qualified Trial resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/studies/{study}/trials/{trial}

Parameters
  • project (String)
  • location (String)
  • study (String)
  • trial (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)