Package com.hashicorp.cdktf.providers.google.bigquery_routine

Interface BigqueryRoutineConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    BigqueryRoutineConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:17.722Z")
@Stability(Stable)
public interface BigqueryRoutineConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getDatasetId

        @Stability(Stable)
@NotNull
String getDatasetId()
        The ID of the dataset containing this routine.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#dataset_id BigqueryRoutine#dataset_id}

      • getDefinitionBody

        @Stability(Stable)
@NotNull
String getDefinitionBody()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#definition_body BigqueryRoutine#definition_body}

      • getRoutineId

        @Stability(Stable)
@NotNull
String getRoutineId()
        The ID of the the routine.

        The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#routine_id BigqueryRoutine#routine_id}

      • getRoutineType

        @Stability(Stable)
@NotNull
String getRoutineType()
        The type of routine. Possible values: ["SCALAR_FUNCTION", "PROCEDURE", "TABLE_VALUED_FUNCTION"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#routine_type BigqueryRoutine#routine_type}

      • getArguments

        @Stability(Stable)
@Nullable
default Object getArguments()
        arguments block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#arguments BigqueryRoutine#arguments}

      • getDataGovernanceType

        @Stability(Stable)
@Nullable
default String getDataGovernanceType()
        If set to DATA_MASKING, the function is validated and made available as a masking function.

        For more information, see https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask Possible values: ["DATA_MASKING"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#data_governance_type BigqueryRoutine#data_governance_type}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        The description of the routine if defined.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#description BigqueryRoutine#description}

      • getDeterminismLevel

        @Stability(Stable)
@Nullable
default String getDeterminismLevel()
        The determinism level of the JavaScript UDF if defined. Possible values: ["DETERMINISM_LEVEL_UNSPECIFIED", "DETERMINISTIC", "NOT_DETERMINISTIC"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#determinism_level BigqueryRoutine#determinism_level}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#id BigqueryRoutine#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getImportedLibraries

        @Stability(Stable)
@Nullable
default List<String> getImportedLibraries()
        Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#imported_libraries BigqueryRoutine#imported_libraries}

      • getLanguage

        @Stability(Stable)
@Nullable
default String getLanguage()
        The language of the routine. Possible values: ["SQL", "JAVASCRIPT", "PYTHON", "JAVA", "SCALA"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#language BigqueryRoutine#language}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#project BigqueryRoutine#project}.

      • getRemoteFunctionOptions

        @Stability(Stable)
@Nullable
default BigqueryRoutineRemoteFunctionOptions getRemoteFunctionOptions()
        remote_function_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#remote_function_options BigqueryRoutine#remote_function_options}

      • getReturnTableType

        @Stability(Stable)
@Nullable
default String getReturnTableType()
        Optional. Can be set only if routineType = "TABLE_VALUED_FUNCTION".

        If absent, the return table type is inferred from definitionBody at query time in each query that references this routine. If present, then the columns in the evaluated table result will be cast to match the column types specificed in return table type, at query time. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#return_table_type BigqueryRoutine#return_table_type}

      • getReturnType

        @Stability(Stable)
@Nullable
default String getReturnType()
        A JSON schema for the return type.

        Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definitionBody at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. ~>**NOTE**: Because this field expects a JSON string, any changes to the string will create a diff, even if the JSON itself hasn't changed. If the API returns a different value for the same schema, e.g. it switche d the order of values or replaced STRUCT field type with RECORD field type, we currently cannot suppress the recurring diff this causes. As a workaround, we recommend using the schema as returned by the API. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#return_type BigqueryRoutine#return_type}

      • getSparkOptions

        @Stability(Stable)
@Nullable
default BigqueryRoutineSparkOptions getSparkOptions()
        spark_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#spark_options BigqueryRoutine#spark_options}

      • getTimeouts

        @Stability(Stable)
@Nullable
default BigqueryRoutineTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_routine#timeouts BigqueryRoutine#timeouts}