Class: Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::BigQueryDestination

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/asset/v1/asset_service.rb

Overview

A BigQuery destination.

Defined Under Namespace

Modules: PartitionKey

Instance Attribute Summary collapse

Instance Attribute Details

#dataset ⇒ ::String

Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId", to which the analysis results should be exported. If this dataset does not exist, the export call will return an INVALID_ARGUMENT error.

Returns:

  • (::String) —

    Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId", to which the analysis results should be exported. If this dataset does not exist, the export call will return an INVALID_ARGUMENT error.



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1286

class BigQueryDestination
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # This enum determines the partition key column for the bigquery tables.
  # Partitioning can improve query performance and reduce query cost by
  # filtering partitions. Refer to
  # https://cloud.google.com/bigquery/docs/partitioned-tables for details.
  module PartitionKey
    # Unspecified partition key. Tables won't be partitioned using this
    # option.
    PARTITION_KEY_UNSPECIFIED = 0

    # The time when the request is received. If specified as partition key,
    # the result table(s) is partitoned by the RequestTime column, an
    # additional timestamp column representing when the request was received.
    REQUEST_TIME = 1
  end
end

#partition_key ⇒ ::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::BigQueryDestination::PartitionKey

Returns The partition key for BigQuery partitioned table.

Returns:



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1286

class BigQueryDestination
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # This enum determines the partition key column for the bigquery tables.
  # Partitioning can improve query performance and reduce query cost by
  # filtering partitions. Refer to
  # https://cloud.google.com/bigquery/docs/partitioned-tables for details.
  module PartitionKey
    # Unspecified partition key. Tables won't be partitioned using this
    # option.
    PARTITION_KEY_UNSPECIFIED = 0

    # The time when the request is received. If specified as partition key,
    # the result table(s) is partitoned by the RequestTime column, an
    # additional timestamp column representing when the request was received.
    REQUEST_TIME = 1
  end
end

#table_prefix ⇒ ::String

Returns Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist:

  • _analysis table will contain export operation's metadata.
  • _analysis_result will contain all the IamPolicyAnalysisResult. When [partition_key] is specified, both tables will be partitioned based on the [partition_key].

Returns:

  • (::String) —

    Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist:

    • _analysis table will contain export operation's metadata.
    • _analysis_result will contain all the IamPolicyAnalysisResult. When [partition_key] is specified, both tables will be partitioned based on the [partition_key].


1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1286

class BigQueryDestination
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # This enum determines the partition key column for the bigquery tables.
  # Partitioning can improve query performance and reduce query cost by
  # filtering partitions. Refer to
  # https://cloud.google.com/bigquery/docs/partitioned-tables for details.
  module PartitionKey
    # Unspecified partition key. Tables won't be partitioned using this
    # option.
    PARTITION_KEY_UNSPECIFIED = 0

    # The time when the request is received. If specified as partition key,
    # the result table(s) is partitoned by the RequestTime column, an
    # additional timestamp column representing when the request was received.
    REQUEST_TIME = 1
  end
end

#write_disposition ⇒ ::String

Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported:

  • WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data.
  • WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition.
  • WRITE_EMPTY: If the table already exists and contains data, an error is returned.

The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file.

Returns:

  • (::String) —

    Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported:

    • WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data.
    • WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition.
    • WRITE_EMPTY: If the table already exists and contains data, an error is returned.

    The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file.



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1286

class BigQueryDestination
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # This enum determines the partition key column for the bigquery tables.
  # Partitioning can improve query performance and reduce query cost by
  # filtering partitions. Refer to
  # https://cloud.google.com/bigquery/docs/partitioned-tables for details.
  module PartitionKey
    # Unspecified partition key. Tables won't be partitioned using this
    # option.
    PARTITION_KEY_UNSPECIFIED = 0

    # The time when the request is received. If specified as partition key,
    # the result table(s) is partitoned by the RequestTime column, an
    # additional timestamp column representing when the request was received.
    REQUEST_TIME = 1
  end
end