com.google.api.services.bigquery.model

Class ExternalRuntimeOptions

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.ExternalRuntimeOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ExternalRuntimeOptions
extends com.google.api.client.json.GenericJson

Options for the runtime of the external system.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExternalRuntimeOptions()

Method Summary

Modifier and Type	Method and Description
ExternalRuntimeOptions	clone()
Double	getContainerCpu() Optional.
String	getContainerMemory() Optional.
Long	getContainerRequestConcurrency() Optional.
Long	getMaxBatchingRows() Optional.
String	getRuntimeConnection() Optional.
String	getRuntimeVersion() Optional.
List<ExternalVolumeMount>	getVolumeMounts() Optional.
ExternalRuntimeOptions	set(String fieldName, Object value)
ExternalRuntimeOptions	setContainerCpu(Double containerCpu) Optional.
ExternalRuntimeOptions	setContainerMemory(String containerMemory) Optional.
ExternalRuntimeOptions	setContainerRequestConcurrency(Long containerRequestConcurrency) Optional.
ExternalRuntimeOptions	setMaxBatchingRows(Long maxBatchingRows) Optional.
ExternalRuntimeOptions	setRuntimeConnection(String runtimeConnection) Optional.
ExternalRuntimeOptions	setRuntimeVersion(String runtimeVersion) Optional.
ExternalRuntimeOptions	setVolumeMounts(List<ExternalVolumeMount> volumeMounts) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ExternalRuntimeOptions

public ExternalRuntimeOptions()

Method Detail

getContainerCpu

public Double getContainerCpu()

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)

Returns:

value or null for none

setContainerCpu

public ExternalRuntimeOptions setContainerCpu(Double containerCpu)

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)

Parameters:

containerCpu - containerCpu or null for none

getContainerMemory

public String getContainerMemory()

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)

Returns:

value or null for none

setContainerMemory

public ExternalRuntimeOptions setContainerMemory(String containerMemory)

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)

Parameters:

containerMemory - containerMemory or null for none

getContainerRequestConcurrency

public Long getContainerRequestConcurrency()

Optional. Maximum number of requests that a Python UDF instance can handle concurrently. If absent or if `0`, the default concurrency value is used. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined- functions-python#configure-container-limits).

Returns:

value or null for none

setContainerRequestConcurrency

public ExternalRuntimeOptions setContainerRequestConcurrency(Long containerRequestConcurrency)

Optional. Maximum number of requests that a Python UDF instance can handle concurrently. If absent or if `0`, the default concurrency value is used. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined- functions-python#configure-container-limits).

Parameters:

containerRequestConcurrency - containerRequestConcurrency or null for none

getMaxBatchingRows

public Long getMaxBatchingRows()

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.

Returns:

value or null for none

setMaxBatchingRows

public ExternalRuntimeOptions setMaxBatchingRows(Long maxBatchingRows)

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.

Parameters:

maxBatchingRows - maxBatchingRows or null for none

getRuntimeConnection

public String getRuntimeConnection()

Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"```

Returns:

value or null for none

setRuntimeConnection

public ExternalRuntimeOptions setRuntimeConnection(String runtimeConnection)

Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"```

Parameters:

runtimeConnection - runtimeConnection or null for none

getRuntimeVersion

public String getRuntimeVersion()

Optional. Language runtime version. Example: `python-3.11`.

Returns:

value or null for none

setRuntimeVersion

public ExternalRuntimeOptions setRuntimeVersion(String runtimeVersion)

Optional. Language runtime version. Example: `python-3.11`.

Parameters:

runtimeVersion - runtimeVersion or null for none

getVolumeMounts

public List<ExternalVolumeMount> getVolumeMounts()

Optional. List of volume mounts for the Python UDF container that executes the managed function.

Returns:

value or null for none

setVolumeMounts

public ExternalRuntimeOptions setVolumeMounts(List<ExternalVolumeMount> volumeMounts)

Optional. List of volume mounts for the Python UDF container that executes the managed function.

Parameters:

volumeMounts - volumeMounts or null for none

set

public ExternalRuntimeOptions set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExternalRuntimeOptions clone()

Overrides:

clone in class com.google.api.client.json.GenericJson