com.google.api.services.bigquery.model

Class RemoteFunctionOptions

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.RemoteFunctionOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Options for a remote user-defined function.

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
RemoteFunctionOptions()

Method Summary

Modifier and Type	Method and Description
RemoteFunctionOptions	clone()
String	getConnection() Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service.
String	getEndpoint() Endpoint of the user-provided remote service, e.g.
Long	getMaxBatchingRows() Max number of rows in each batch sent to the remote service.
Map<String,String>	getUserDefinedContext() User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service.
RemoteFunctionOptions	set(String fieldName, Object value)
RemoteFunctionOptions	setConnection(String connection) Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service.
RemoteFunctionOptions	setEndpoint(String endpoint) Endpoint of the user-provided remote service, e.g.
RemoteFunctionOptions	setMaxBatchingRows(Long maxBatchingRows) Max number of rows in each batch sent to the remote service.
RemoteFunctionOptions	setUserDefinedContext(Map<String,String> userDefinedContext) User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service.

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

RemoteFunctionOptions

public RemoteFunctionOptions()

Method Detail

getConnection

public String getConnection()

Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: ```"projects/{projectId}/locations/{locationId}/connections/{connectionId}"```

Returns:

value or null for none

setConnection

public RemoteFunctionOptions setConnection(String connection)

Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: ```"projects/{projectId}/locations/{locationId}/connections/{connectionId}"```

Parameters:

connection - connection or null for none

getEndpoint

public String getEndpoint()

Endpoint of the user-provided remote service, e.g. ```https://us- east1-my_gcf_project.cloudfunctions.net/remote_add```

Returns:

value or null for none

setEndpoint

public RemoteFunctionOptions setEndpoint(String endpoint)

Endpoint of the user-provided remote service, e.g. ```https://us- east1-my_gcf_project.cloudfunctions.net/remote_add```

Parameters:

endpoint - endpoint or null for none

getMaxBatchingRows

public Long getMaxBatchingRows()

Max number of rows in each batch sent to the remote service. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.

Returns:

value or null for none

setMaxBatchingRows

public RemoteFunctionOptions setMaxBatchingRows(Long maxBatchingRows)

Max number of rows in each batch sent to the remote service. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.

Parameters:

maxBatchingRows - maxBatchingRows or null for none

getUserDefinedContext

public Map<String,String> getUserDefinedContext()

User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service. The total number of bytes of keys and values must be less than 8KB.

Returns:

value or null for none

setUserDefinedContext

public RemoteFunctionOptions setUserDefinedContext(Map<String,String> userDefinedContext)

User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service. The total number of bytes of keys and values must be less than 8KB.

Parameters:

userDefinedContext - userDefinedContext or null for none

set

public RemoteFunctionOptions set(String fieldName,
                                 Object value)

Overrides:

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

clone

public RemoteFunctionOptions clone()

Overrides:

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