feat: Add ExternalRuntimeOptions to BigQuery routine (#2311)

* feat: Add ExternalRuntimeOptions to BigQuery routine
This change introduces the `ExternalRuntimeOptions` class to the
`google.cloud.bigquery.routine` module, allowing users to configure
runtime options for external routines.
Key changes:
- Created the `ExternalRuntimeOptions` class with setters and getters for
`container_memory`, `container_cpu`, `runtime_connection`,
`max_batching_rows`, and `runtime_version`.
- Updated the `Routine` class to include an `external_runtime_options`
property that accepts an `ExternalRuntimeOptions` object.
- Added comprehensive unit tests for the new class and its integration
with the `Routine` class, including tests for both valid and invalid
input values.
* Update google/cloud/bigquery/routine/routine.py
* feat: Add ExternalRuntimeOptions to BigQuery routine
This change introduces the `ExternalRuntimeOptions` class to the
`google.cloud.bigquery.routine` module, allowing users to configure
runtime options for external routines.
Key changes:
- Created the `ExternalRuntimeOptions` class with setters and getters for
`container_memory`, `container_cpu`, `runtime_connection`,
`max_batching_rows`, and `runtime_version`.
- Updated the `Routine` class to include an `external_runtime_options`
property that accepts an `ExternalRuntimeOptions` object.
- Added comprehensive unit tests for the new class and its integration
with the `Routine` class, including tests for both valid and invalid
input values.
* feat: Add ExternalRuntimeOptions to BigQuery routine
This change introduces the `ExternalRuntimeOptions` class to the
`google.cloud.bigquery.routine` module, allowing users to configure
runtime options for external routines.
Key changes:
- Created the `ExternalRuntimeOptions` class with setters and getters for
`container_memory`, `container_cpu`, `runtime_connection`,
`max_batching_rows`, and `runtime_version`.
- Updated the `Routine` class to include an `external_runtime_options`
property that accepts an `ExternalRuntimeOptions` object.
- Added comprehensive unit tests for the new class and its integration
with the `Routine` class, including tests for both valid and invalid
input values.
- Added additional tests to improve code coverage based on feedback.
* feat: Add ExternalRuntimeOptions to BigQuery routine
This change introduces the `ExternalRuntimeOptions` class to the
`google.cloud.bigquery.routine` module, allowing users to configure
runtime options for external routines.
Key changes:
- Created the `ExternalRuntimeOptions` class with setters and getters for
`container_memory`, `container_cpu`, `runtime_connection`,
`max_batching_rows`, and `runtime_version`.
- Updated the `Routine` class to include an `external_runtime_options`
property that accepts an `ExternalRuntimeOptions` object.
- Added comprehensive unit tests for the new class and its integration
with the `Routine` class, including tests for both valid and invalid
input values.
- Added additional tests to improve code coverage based on feedback.
- Addressed PyType errors by using helper functions for type conversion.
* Update tests/unit/routine/test_external_runtime_options.py
* feat: Add ExternalRuntimeOptions to BigQuery routine
This change introduces the `ExternalRuntimeOptions` class to the
`google.cloud.bigquery.routine` module, allowing users to configure
runtime options for external routines.
Key changes:
- Created the `ExternalRuntimeOptions` class with setters and getters for
`container_memory`, `container_cpu`, `runtime_connection`,
`max_batching_rows`, and `runtime_version`.
- Updated the `Routine` class to include an `external_runtime_options`
property that accepts an `ExternalRuntimeOptions` object.
- Added comprehensive unit tests for the new class and its integration
with the `Routine` class, including tests for both valid and invalid
input values.
- Added additional tests to improve code coverage based on feedback.
- Addressed PyType errors by using helper functions for type conversion.
- Addressed formatting nits from code review.
---------
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: Chalmer Lowe <chalmerlowe@google.com>
Co-authored-by: Lingqing Gan <lingqing.gan@gmail.com>

Author: 3 people

google/cloud/bigquery/__init__.py

@@ -98,6 +98,7 @@
 fromgoogle.cloud.bigquery.routineimportRoutineReference
 fromgoogle.cloud.bigquery.routineimportRoutineType
 fromgoogle.cloud.bigquery.routineimportRemoteFunctionOptions
+fromgoogle.cloud.bigquery.routineimportExternalRuntimeOptions
 fromgoogle.cloud.bigquery.schemaimportPolicyTagList
 fromgoogle.cloud.bigquery.schemaimportSchemaField
 fromgoogle.cloud.bigquery.schemaimportFieldElementType
@@ -181,6 +182,7 @@
 "RoutineArgument",
 "RoutineReference",
 "RemoteFunctionOptions",
+"ExternalRuntimeOptions",
 # Shared helpers
 "SchemaField",
 "FieldElementType",

google/cloud/bigquery/routine/__init__.py

@@ -21,6 +21,7 @@
 fromgoogle.cloud.bigquery.routine.routineimportRoutineReference
 fromgoogle.cloud.bigquery.routine.routineimportRoutineType
 fromgoogle.cloud.bigquery.routine.routineimportRemoteFunctionOptions
+fromgoogle.cloud.bigquery.routine.routineimportExternalRuntimeOptions
 
 
 __all__= (
@@ -30,4 +31,5 @@
 "RoutineReference",
 "RoutineType",
 "RemoteFunctionOptions",
+"ExternalRuntimeOptions",
 )

google/cloud/bigquery/routine/routine.py

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 """Define resources for the BigQuery Routines API."""
-
+importtyping
 fromtypingimportAny, Dict, Optional, Union
 
 importgoogle.cloud._helpers# type: ignore
@@ -69,6 +69,7 @@ class Routine(object):
 "determinism_level": "determinismLevel",
 "remote_function_options": "remoteFunctionOptions",
 "data_governance_type": "dataGovernanceType",
+"external_runtime_options": "externalRuntimeOptions",
  }
 
 def__init__(self, routine_ref, **kwargs) ->None:
@@ -349,6 +350,37 @@ def data_governance_type(self, value):
  )
 self._properties[self._PROPERTY_TO_API_FIELD["data_governance_type"]] =value
 
+@property
+defexternal_runtime_options(self):
+"""Optional[google.cloud.bigquery.routine.ExternalRuntimeOptions]:
+ Configures the external runtime options for a routine.
+
+ Raises:
+ ValueError:
+ If the value is not
+ :class:`~google.cloud.bigquery.routine.ExternalRuntimeOptions` or
+ :data:`None`.
+ """
+prop=self._properties.get(
+self._PROPERTY_TO_API_FIELD["external_runtime_options"]
+ )
+ifpropisnotNone:
+returnExternalRuntimeOptions.from_api_repr(prop)
+
+@external_runtime_options.setter
+defexternal_runtime_options(self, value):
+api_repr=value
+ifisinstance(value, ExternalRuntimeOptions):
+api_repr=value.to_api_repr()
+elifvalueisnotNone:
+raiseValueError(
+"value must be google.cloud.bigquery.routine.ExternalRuntimeOptions "
+"or None"
+ )
+self._properties[
+self._PROPERTY_TO_API_FIELD["external_runtime_options"]
+ ] =api_repr
+
 @classmethod
 deffrom_api_repr(cls, resource: dict) ->"Routine":
 """Factory: construct a routine given its API representation.
@@ -736,3 +768,154 @@ def __repr__(self):
 forproperty_nameinsorted(self._PROPERTY_TO_API_FIELD)
  ]
 return"RemoteFunctionOptions({})".format(", ".join(all_properties))
+
+
+classExternalRuntimeOptions(object):
+"""Options for the runtime of the external system.
+
+ Args:
+ container_memory (str):
+ Optional. Amount of memory provisioned for a Python UDF container
+ instance. Format: {number}{unit} where unit is one of "M", "G", "Mi"
+ and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is
+ 512Mi. For more information, see `Configure container limits for
+ Python UDFs <https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits>`_
+ container_cpu (int):
+ Optional. Amount of CPU provisioned for a Python UDF container
+ instance. For more information, see `Configure container limits
+ for Python UDFs <https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits>`_
+ runtime_connection (str):
+ Optional. Fully qualified name of the connection whose service account
+ will be used to execute the code in the container. Format:
+ "projects/{projectId}/locations/{locationId}/connections/{connectionId}"
+ max_batching_rows (int):
+ Optional. Maximum number of rows in each batch sent to the external
+ runtime. If absent or if 0, BigQuery dynamically decides the number of
+ rows in a batch.
+ runtime_version (str):
+ Optional. Language runtime version. Example: python-3.11.
+ """
+
+_PROPERTY_TO_API_FIELD= {
+"container_memory": "containerMemory",
+"container_cpu": "containerCpu",
+"runtime_connection": "runtimeConnection",
+"max_batching_rows": "maxBatchingRows",
+"runtime_version": "runtimeVersion",
+ }
+
+def__init__(
+self,
+container_memory: Optional[str] =None,
+container_cpu: Optional[int] =None,
+runtime_connection: Optional[str] =None,
+max_batching_rows: Optional[int] =None,
+runtime_version: Optional[str] =None,
+_properties: Optional[Dict] =None,
+ ) ->None:
+if_propertiesisNone:
+_properties= {}
+self._properties=_properties
+
+ifcontainer_memoryisnotNone:
+self.container_memory=container_memory
+ifcontainer_cpuisnotNone:
+self.container_cpu=container_cpu
+ifruntime_connectionisnotNone:
+self.runtime_connection=runtime_connection
+ifmax_batching_rowsisnotNone:
+self.max_batching_rows=max_batching_rows
+ifruntime_versionisnotNone:
+self.runtime_version=runtime_version
+
+@property
+defcontainer_memory(self) ->Optional[str]:
+"""Optional. Amount of memory provisioned for a Python UDF container instance."""
+return_helpers._str_or_none(self._properties.get("containerMemory"))
+
+@container_memory.setter
+defcontainer_memory(self, value: Optional[str]):
+ifvalueisnotNoneandnotisinstance(value, str):
+raiseValueError("container_memory must be a string or None.")
+self._properties["containerMemory"] =value
+
+@property
+defcontainer_cpu(self) ->Optional[int]:
+"""Optional. Amount of CPU provisioned for a Python UDF container instance."""
+return_helpers._int_or_none(self._properties.get("containerCpu"))
+
+@container_cpu.setter
+defcontainer_cpu(self, value: Optional[int]):
+ifvalueisnotNoneandnotisinstance(value, int):
+raiseValueError("container_cpu must be an integer or None.")
+self._properties["containerCpu"] =value
+
+@property
+defruntime_connection(self) ->Optional[str]:
+"""Optional. Fully qualified name of the connection."""
+return_helpers._str_or_none(self._properties.get("runtimeConnection"))
+
+@runtime_connection.setter
+defruntime_connection(self, value: Optional[str]):
+ifvalueisnotNoneandnotisinstance(value, str):
+raiseValueError("runtime_connection must be a string or None.")
+self._properties["runtimeConnection"] =value
+
+@property
+defmax_batching_rows(self) ->Optional[int]:
+"""Optional. Maximum number of rows in each batch sent to the external runtime."""
+returntyping.cast(
+int, _helpers._int_or_none(self._properties.get("maxBatchingRows"))
+ )
+
+@max_batching_rows.setter
+defmax_batching_rows(self, value: Optional[int]):
+ifvalueisnotNoneandnotisinstance(value, int):
+raiseValueError("max_batching_rows must be an integer or None.")
+self._properties["maxBatchingRows"] =_helpers._str_or_none(value)
+
+@property
+defruntime_version(self) ->Optional[str]:
+"""Optional. Language runtime version."""
+return_helpers._str_or_none(self._properties.get("runtimeVersion"))
+
+@runtime_version.setter
+defruntime_version(self, value: Optional[str]):
+ifvalueisnotNoneandnotisinstance(value, str):
+raiseValueError("runtime_version must be a string or None.")
+self._properties["runtimeVersion"] =value
+
+@classmethod
+deffrom_api_repr(cls, resource: dict) ->"ExternalRuntimeOptions":
+"""Factory: construct external runtime options given its API representation.
+ Args:
+ resource (Dict[str, object]): Resource, as returned from the API.
+ Returns:
+ google.cloud.bigquery.routine.ExternalRuntimeOptions:
+ Python object, as parsed from ``resource``.
+ """
+ref=cls()
+ref._properties=resource
+returnref
+
+defto_api_repr(self) ->dict:
+"""Construct the API resource representation of this ExternalRuntimeOptions.
+ Returns:
+ Dict[str, object]: External runtime options represented as an API resource.
+ """
+returnself._properties
+
+def__eq__(self, other):
+ifnotisinstance(other, ExternalRuntimeOptions):
+returnNotImplemented
+returnself._properties==other._properties
+
+def__ne__(self, other):
+returnnotself==other
+
+def__repr__(self):
+all_properties= [
+"{}={}".format(property_name, repr(getattr(self, property_name)))
+forproperty_nameinsorted(self._PROPERTY_TO_API_FIELD)
+ ]
+return"ExternalRuntimeOptions({})".format(", ".join(all_properties))