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

Inherits:

Object

• Object
• Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/asset/v1/asset_service.rb

Overview

Output configuration for export IAM policy analysis destination.

Defined Under Namespace

Classes: BigQueryDestination, GcsDestination

Instance Attribute Summary

• #bigquery_destination ⇒ ::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::BigQueryDestination

  Destination on BigQuery.

• #gcs_destination ⇒ ::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::GcsDestination

  Destination on Cloud Storage.

Instance Attribute Details

#bigquery_destination ⇒ ::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::BigQueryDestination

Returns Destination on BigQuery.

Returns:

• (::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::BigQueryDestination) —

  Destination on BigQuery.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1193

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

  # A Cloud Storage location.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The uri of the Cloud Storage object. It's the same uri that is
  #     used by gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
  #     Editing Object
  #     Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
  #     for more information.
  #
  #     If the specified Cloud Storage object already exists and there is no
  #     [hold](https://cloud.google.com/storage/docs/object-holds), it will be
  #     overwritten with the analysis result.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A BigQuery destination.
  # @!attribute [rw] dataset
  #   @return [::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.
  # @!attribute [rw] table_prefix
  #   @return [::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:
  #     * <table_prefix>_analysis table will contain export operation's metadata.
  #     * <table_prefix>_analysis_result will contain all the
  #       {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult IamPolicyAnalysisResult}.
  #     When [partition_key] is specified, both tables will be partitioned based
  #     on the [partition_key].
  # @!attribute [rw] partition_key
  #   @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::BigQueryDestination::PartitionKey]
  #     The partition key for BigQuery partitioned table.
  # @!attribute [rw] write_disposition
  #   @return [::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.
  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
end

#gcs_destination ⇒ ::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::GcsDestination

Returns Destination on Cloud Storage.

Returns:

• (::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::GcsDestination) —

  Destination on Cloud Storage.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1193

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

  # A Cloud Storage location.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The uri of the Cloud Storage object. It's the same uri that is
  #     used by gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
  #     Editing Object
  #     Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
  #     for more information.
  #
  #     If the specified Cloud Storage object already exists and there is no
  #     [hold](https://cloud.google.com/storage/docs/object-holds), it will be
  #     overwritten with the analysis result.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A BigQuery destination.
  # @!attribute [rw] dataset
  #   @return [::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.
  # @!attribute [rw] table_prefix
  #   @return [::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:
  #     * <table_prefix>_analysis table will contain export operation's metadata.
  #     * <table_prefix>_analysis_result will contain all the
  #       {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult IamPolicyAnalysisResult}.
  #     When [partition_key] is specified, both tables will be partitioned based
  #     on the [partition_key].
  # @!attribute [rw] partition_key
  #   @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig::BigQueryDestination::PartitionKey]
  #     The partition key for BigQuery partitioned table.
  # @!attribute [rw] write_disposition
  #   @return [::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.
  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
end