Class: Google::Apis::BigqueryV2::Routine

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Overview

A user-defined function or a stored procedure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Routine

Returns a new instance of Routine.



8164
8165
8166
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8164

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#arguments ⇒ Array<Google::Apis::BigqueryV2::Argument>

Optional. Corresponds to the JSON property arguments

Returns:



8046
8047
8048
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8046

def arguments
  @arguments
end

#creation_time ⇒ Fixnum

Output only. The time when this routine was created, in milliseconds since the epoch. Corresponds to the JSON property creationTime

Returns:

  • (Fixnum) 


8052
8053
8054
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8052

def creation_time
  @creation_time
end

#data_governance_type ⇒ String

Optional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines. Corresponds to the JSON property dataGovernanceType

Returns:

  • (String) 


8060
8061
8062
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8060

def data_governance_type
  @data_governance_type
end

#definition_body ⇒ String

Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n Note that both \n are replaced with linebreaks. Corresponds to the JSON property definitionBody

Returns:

  • (String) 


8074
8075
8076
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8074

def definition_body
  @definition_body
end

#description ⇒ String

Optional. The description of the routine, if defined. Corresponds to the JSON property description

Returns:

  • (String) 


8079
8080
8081
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8079

def description
  @description
end

#determinism_level ⇒ String

Optional. The determinism level of the JavaScript UDF, if defined. Corresponds to the JSON property determinismLevel

Returns:

  • (String) 


8084
8085
8086
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8084

def determinism_level
  @determinism_level
end

#etag ⇒ String

Output only. A hash of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


8089
8090
8091
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8089

def etag
  @etag
end

#imported_libraries ⇒ Array<String>

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. Corresponds to the JSON property importedLibraries

Returns:

  • (Array<String>) 


8095
8096
8097
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8095

def imported_libraries
  @imported_libraries
end

#language ⇒ String

Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. Corresponds to the JSON property language

Returns:

  • (String) 


8101
8102
8103
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8101

def language
  @language
end

#last_modified_time ⇒ Fixnum

Output only. The time when this routine was last modified, in milliseconds since the epoch. Corresponds to the JSON property lastModifiedTime

Returns:

  • (Fixnum) 


8107
8108
8109
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8107

def last_modified_time
  @last_modified_time
end

#remote_function_options ⇒ Google::Apis::BigqueryV2::RemoteFunctionOptions

Options for a remote user-defined function. Corresponds to the JSON property remoteFunctionOptions

Returns:



8112
8113
8114
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8112

def remote_function_options
  @remote_function_options
end

#return_table_type ⇒ Google::Apis::BigqueryV2::StandardSqlTableType

A table type Corresponds to the JSON property returnTableType

Returns:



8117
8118
8119
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8117

def return_table_type
  @return_table_type
end

#return_type ⇒ Google::Apis::BigqueryV2::StandardSqlDataType

The data type of a variable such as a function argument. Examples include: * INT64: "typeKind": "INT64" * ARRAY: "typeKind": "ARRAY", " arrayElementType":"typeKind": "STRING" * STRUCT>: "typeKind": "STRUCT", "structType": "fields": [ "name": "x", "type":"typeKind": "STRING", "name": "y", "type": "typeKind": "ARRAY", "arrayElementType": "typeKind": " DATE" ] Corresponds to the JSON property returnType

Returns:



8127
8128
8129
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8127

def return_type
  @return_type
end

#routine_reference ⇒ Google::Apis::BigqueryV2::RoutineReference

Id path of a routine. Corresponds to the JSON property routineReference

Returns:



8132
8133
8134
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8132

def routine_reference
  @routine_reference
end

#routine_type ⇒ String

Required. The type of routine. Corresponds to the JSON property routineType

Returns:

  • (String) 


8137
8138
8139
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8137

def routine_type
  @routine_type
end

#security_mode ⇒ String

Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration. Corresponds to the JSON property securityMode

Returns:

  • (String) 


8143
8144
8145
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8143

def security_mode
  @security_mode
end

#spark_options ⇒ Google::Apis::BigqueryV2::SparkOptions

Options for a user-defined Spark routine. Corresponds to the JSON property sparkOptions

Returns:



8148
8149
8150
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8148

def spark_options
  @spark_options
end

#strict_mode ⇒ Boolean Also known as: strict_mode?

Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If strictMode is set to TRUE, the procedure body is further checked for errors such as non-existent tables or columns. The CREATE PROCEDURE statement fails if the body fails any of these checks. If strictMode is set to FALSE, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify strictMode=FALSE to avoid non-existent procedure errors during validation. Default value is TRUE. Corresponds to the JSON property strictMode

Returns:

  • (Boolean) 


8161
8162
8163
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8161

def strict_mode
  @strict_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8169

def update!(**args)
  @arguments = args[:arguments] if args.key?(:arguments)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @data_governance_type = args[:data_governance_type] if args.key?(:data_governance_type)
  @definition_body = args[:definition_body] if args.key?(:definition_body)
  @description = args[:description] if args.key?(:description)
  @determinism_level = args[:determinism_level] if args.key?(:determinism_level)
  @etag = args[:etag] if args.key?(:etag)
  @imported_libraries = args[:imported_libraries] if args.key?(:imported_libraries)
  @language = args[:language] if args.key?(:language)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @remote_function_options = args[:remote_function_options] if args.key?(:remote_function_options)
  @return_table_type = args[:return_table_type] if args.key?(:return_table_type)
  @return_type = args[:return_type] if args.key?(:return_type)
  @routine_reference = args[:routine_reference] if args.key?(:routine_reference)
  @routine_type = args[:routine_type] if args.key?(:routine_type)
  @security_mode = args[:security_mode] if args.key?(:security_mode)
  @spark_options = args[:spark_options] if args.key?(:spark_options)
  @strict_mode = args[:strict_mode] if args.key?(:strict_mode)
end