Skip to content

feat: Add reservation affinity support to preview BatchPredictionJob #5911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Nov 3, 2025
Merged

feat: Add reservation affinity support to preview BatchPredictionJob #5911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion google/cloud/aiplatform/jobs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ def cancel(self) -> None:
getattr(self.api_client, self._cancel_method)(name=self.resource_name)


class BatchPredictionJob(_Job):
class BatchPredictionJob(_Job, base.PreviewMixin):

_resource_noun = "batchPredictionJobs"
_getter_method = "get_batch_prediction_job"
Expand All @@ -329,6 +329,9 @@ class BatchPredictionJob(_Job):
_job_type = "batch-predictions"
_parse_resource_name_method = "parse_batch_prediction_job_path"
_format_resource_name_method = "batch_prediction_job_path"
_preview_class = (
"google.cloud.aiplatform.aiplatform.preview.jobs.BatchPredictionJob"
)

def __init__(
self,
Expand Down Expand Up @@ -949,6 +952,9 @@ def _submit_impl(
] = None,
analysis_instance_schema_uri: Optional[str] = None,
service_account: Optional[str] = None,
reservation_affinity_type: Optional[str] = None,
reservation_affinity_key: Optional[str] = None,
reservation_affinity_values: Optional[Sequence[str]] = None,
wait_for_completion: bool = False,
) -> "BatchPredictionJob":
"""Create a batch prediction job.
Expand Down Expand Up @@ -1136,6 +1142,18 @@ def _submit_impl(
service_account (str):
Optional. Specifies the service account for workload run-as account.
Users submitting jobs must have act-as permission on this run-as account.
reservation_affinity_type (str):
Optional. The type of reservation affinity.
One of NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION,
SPECIFIC_THEN_ANY_RESERVATION, SPECIFIC_THEN_NO_RESERVATION
reservation_affinity_key (str):
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_values (List[str]):
Optional. Corresponds to the label values of a reservation resource.
This must be the full resource name of the reservation.
Format: 'projects/{project_id_or_number}/zones/{zone}/reservations/{reservation_name}'
wait_for_completion (bool):
Whether to wait for the job completion.
Returns:
Expand Down Expand Up @@ -1268,6 +1286,13 @@ def _submit_impl(
machine_spec.accelerator_type = accelerator_type
machine_spec.accelerator_count = accelerator_count

if reservation_affinity_type:
machine_spec.reservation_affinity = utils.get_reservation_affinity(
reservation_affinity_type,
reservation_affinity_key,
reservation_affinity_values,
)

dedicated_resources = gca_machine_resources_compat.BatchDedicatedResources()

dedicated_resources.machine_spec = machine_spec
Expand Down
Loading