target.apidocs.com.google.api.services.bigquery.model.ViewDefinition.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigquery Show documentation

There is a newer version: v2-rev20241027-2.0.0

Show newest version







ViewDefinition (BigQuery API v2-rev20240919-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigquery.model
Class ViewDefinition



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class ViewDefinition
extends com.google.api.client.json.GenericJson
Describes the definition of a logical view.

  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


ViewDefinition() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


ViewDefinition
clone() 


List<ForeignViewDefinition>
getForeignDefinitions()
Optional.



PrivacyPolicy
getPrivacyPolicy()
Optional.



String
getQuery()
Required.



Boolean
getUseExplicitColumnNames()
True if the column names are explicitly specified.



Boolean
getUseLegacySql()
Specifies whether to use BigQuery's legacy SQL for this view.



List<UserDefinedFunctionResource>
getUserDefinedFunctionResources()
Describes user-defined function resources used in the query.



ViewDefinition
set(String fieldName,
   Object value) 


ViewDefinition
setForeignDefinitions(List<ForeignViewDefinition> foreignDefinitions)
Optional.



ViewDefinition
setPrivacyPolicy(PrivacyPolicy privacyPolicy)
Optional.



ViewDefinition
setQuery(String query)
Required.



ViewDefinition
setUseExplicitColumnNames(Boolean useExplicitColumnNames)
True if the column names are explicitly specified.



ViewDefinition
setUseLegacySql(Boolean useLegacySql)
Specifies whether to use BigQuery's legacy SQL for this view.



ViewDefinition
setUserDefinedFunctionResources(List<UserDefinedFunctionResource> userDefinedFunctionResources)
Describes user-defined function resources used in the query.







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





ViewDefinition
public ViewDefinition()









Method Detail





getForeignDefinitions
public List<ForeignViewDefinition> getForeignDefinitions()
Optional. Foreign view representations.

Returns:
value or null for none








setForeignDefinitions
public ViewDefinition setForeignDefinitions(List<ForeignViewDefinition> foreignDefinitions)
Optional. Foreign view representations.

Parameters:
foreignDefinitions - foreignDefinitions or null for none








getPrivacyPolicy
public PrivacyPolicy getPrivacyPolicy()
Optional. Specifices the privacy policy for the view.

Returns:
value or null for none








setPrivacyPolicy
public ViewDefinition setPrivacyPolicy(PrivacyPolicy privacyPolicy)
Optional. Specifices the privacy policy for the view.

Parameters:
privacyPolicy - privacyPolicy or null for none








getQuery
public String getQuery()
Required. A query that BigQuery executes when the view is referenced.

Returns:
value or null for none








setQuery
public ViewDefinition setQuery(String query)
Required. A query that BigQuery executes when the view is referenced.

Parameters:
query - query or null for none








getUseExplicitColumnNames
public Boolean getUseExplicitColumnNames()
True if the column names are explicitly specified. For example by using the 'CREATE VIEW v(c1,
 c2) AS ...' syntax. Can only be set for GoogleSQL views.

Returns:
value or null for none








setUseExplicitColumnNames
public ViewDefinition setUseExplicitColumnNames(Boolean useExplicitColumnNames)
True if the column names are explicitly specified. For example by using the 'CREATE VIEW v(c1,
 c2) AS ...' syntax. Can only be set for GoogleSQL views.

Parameters:
useExplicitColumnNames - useExplicitColumnNames or null for none








getUseLegacySql
public Boolean getUseLegacySql()
Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set
 to false, the view will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-
 reference/ Queries and views that reference this view must use the same flag value. A wrapper
 is used here because the default value is True.

Returns:
value or null for none








setUseLegacySql
public ViewDefinition setUseLegacySql(Boolean useLegacySql)
Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set
 to false, the view will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-
 reference/ Queries and views that reference this view must use the same flag value. A wrapper
 is used here because the default value is True.

Parameters:
useLegacySql - useLegacySql or null for none








getUserDefinedFunctionResources
public List<UserDefinedFunctionResource> getUserDefinedFunctionResources()
Describes user-defined function resources used in the query.

Returns:
value or null for none








setUserDefinedFunctionResources
public ViewDefinition setUserDefinedFunctionResources(List<UserDefinedFunctionResource> userDefinedFunctionResources)
Describes user-defined function resources used in the query.

Parameters:
userDefinedFunctionResources - userDefinedFunctionResources or null for none








set
public ViewDefinition set(String fieldName,
                          Object value)

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








clone
public ViewDefinition clone()

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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`ViewDefinition`	`clone()`
`List<ForeignViewDefinition>`	`getForeignDefinitions()` Optional.
`PrivacyPolicy`	`getPrivacyPolicy()` Optional.
`String`	`getQuery()` Required.
`Boolean`	`getUseExplicitColumnNames()` True if the column names are explicitly specified.
`Boolean`	`getUseLegacySql()` Specifies whether to use BigQuery's legacy SQL for this view.
`List<UserDefinedFunctionResource>`	`getUserDefinedFunctionResources()` Describes user-defined function resources used in the query.
`ViewDefinition`	`set(String fieldName, Object value)`
`ViewDefinition`	`setForeignDefinitions(List<ForeignViewDefinition> foreignDefinitions)` Optional.
`ViewDefinition`	`setPrivacyPolicy(PrivacyPolicy privacyPolicy)` Optional.
`ViewDefinition`	`setQuery(String query)` Required.
`ViewDefinition`	`setUseExplicitColumnNames(Boolean useExplicitColumnNames)` True if the column names are explicitly specified.
`ViewDefinition`	`setUseLegacySql(Boolean useLegacySql)` Specifies whether to use BigQuery's legacy SQL for this view.
`ViewDefinition`	`setUserDefinedFunctionResources(List<UserDefinedFunctionResource> userDefinedFunctionResources)` Describes user-defined function resources used in the query.