Class: Google::Cloud::Dlp::V2::TransformationSummary

Inherits:

Object

Object
Google::Cloud::Dlp::V2::TransformationSummary

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/privacy/dlp/v2/dlp.rb

Overview

Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.

Defined Under Namespace

Modules: TransformationResultCode Classes: SummaryResult

Instance Attribute Summary collapse

#field ⇒ ::Google::Cloud::Dlp::V2::FieldId
Set if the transformation was limited to a specific FieldId.
#field_transformations ⇒ ::Array<::Google::Cloud::Dlp::V2::FieldTransformation>
The field transformation that was applied.
#info_type ⇒ ::Google::Cloud::Dlp::V2::InfoType
Set if the transformation was limited to a specific InfoType.
#record_suppress ⇒ ::Google::Cloud::Dlp::V2::RecordSuppression
The specific suppression option these stats apply to.
#results ⇒ ::Array<::Google::Cloud::Dlp::V2::TransformationSummary::SummaryResult>
Collection of all transformations that took place or had an error.
#transformation ⇒ ::Google::Cloud::Dlp::V2::PrimitiveTransformation
The specific transformation these stats apply to.
#transformed_bytes ⇒ ::Integer
Total size in bytes that were transformed in some way.

Instance Attribute Details

#field ⇒ `::Google::Cloud::Dlp::V2::FieldId`

Returns Set if the transformation was limited to a specific FieldId.

Returns:

(::Google::Cloud::Dlp::V2::FieldId) —
Set if the transformation was limited to a specific FieldId.

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3210

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

  # A collection that informs the user the number of times a particular
  # `TransformationResultCode` and error details occurred.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     Number of transformations counted by this result.
  # @!attribute [rw] code
  #   @return [::Google::Cloud::Dlp::V2::TransformationSummary::TransformationResultCode]
  #     Outcome of the transformation.
  # @!attribute [rw] details
  #   @return [::String]
  #     A place for warnings or errors to show up if a transformation didn't
  #     work as expected.
  class SummaryResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible outcomes of transformations.
  module TransformationResultCode
    # Unused
    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0

    # Transformation completed without an error.
    SUCCESS = 1

    # Transformation had an error.
    ERROR = 2
  end
end

#field_transformations ⇒ `::Array<::Google::Cloud::Dlp::V2::FieldTransformation>`

Returns The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.

Returns:

(::Array<::Google::Cloud::Dlp::V2::FieldTransformation>) —
The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3210

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

  # A collection that informs the user the number of times a particular
  # `TransformationResultCode` and error details occurred.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     Number of transformations counted by this result.
  # @!attribute [rw] code
  #   @return [::Google::Cloud::Dlp::V2::TransformationSummary::TransformationResultCode]
  #     Outcome of the transformation.
  # @!attribute [rw] details
  #   @return [::String]
  #     A place for warnings or errors to show up if a transformation didn't
  #     work as expected.
  class SummaryResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible outcomes of transformations.
  module TransformationResultCode
    # Unused
    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0

    # Transformation completed without an error.
    SUCCESS = 1

    # Transformation had an error.
    ERROR = 2
  end
end

#info_type ⇒ `::Google::Cloud::Dlp::V2::InfoType`

Returns Set if the transformation was limited to a specific InfoType.

Returns:

(::Google::Cloud::Dlp::V2::InfoType) —
Set if the transformation was limited to a specific InfoType.

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3210

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

  # A collection that informs the user the number of times a particular
  # `TransformationResultCode` and error details occurred.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     Number of transformations counted by this result.
  # @!attribute [rw] code
  #   @return [::Google::Cloud::Dlp::V2::TransformationSummary::TransformationResultCode]
  #     Outcome of the transformation.
  # @!attribute [rw] details
  #   @return [::String]
  #     A place for warnings or errors to show up if a transformation didn't
  #     work as expected.
  class SummaryResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible outcomes of transformations.
  module TransformationResultCode
    # Unused
    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0

    # Transformation completed without an error.
    SUCCESS = 1

    # Transformation had an error.
    ERROR = 2
  end
end

#record_suppress ⇒ `::Google::Cloud::Dlp::V2::RecordSuppression`

Returns The specific suppression option these stats apply to.

Returns:

(::Google::Cloud::Dlp::V2::RecordSuppression) —
The specific suppression option these stats apply to.

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3210

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

  # A collection that informs the user the number of times a particular
  # `TransformationResultCode` and error details occurred.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     Number of transformations counted by this result.
  # @!attribute [rw] code
  #   @return [::Google::Cloud::Dlp::V2::TransformationSummary::TransformationResultCode]
  #     Outcome of the transformation.
  # @!attribute [rw] details
  #   @return [::String]
  #     A place for warnings or errors to show up if a transformation didn't
  #     work as expected.
  class SummaryResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible outcomes of transformations.
  module TransformationResultCode
    # Unused
    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0

    # Transformation completed without an error.
    SUCCESS = 1

    # Transformation had an error.
    ERROR = 2
  end
end

#results ⇒ `::Array<::Google::Cloud::Dlp::V2::TransformationSummary::SummaryResult>`

Returns Collection of all transformations that took place or had an error.

Returns:

(::Array<::Google::Cloud::Dlp::V2::TransformationSummary::SummaryResult>) —
Collection of all transformations that took place or had an error.

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3210

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

  # A collection that informs the user the number of times a particular
  # `TransformationResultCode` and error details occurred.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     Number of transformations counted by this result.
  # @!attribute [rw] code
  #   @return [::Google::Cloud::Dlp::V2::TransformationSummary::TransformationResultCode]
  #     Outcome of the transformation.
  # @!attribute [rw] details
  #   @return [::String]
  #     A place for warnings or errors to show up if a transformation didn't
  #     work as expected.
  class SummaryResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible outcomes of transformations.
  module TransformationResultCode
    # Unused
    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0

    # Transformation completed without an error.
    SUCCESS = 1

    # Transformation had an error.
    ERROR = 2
  end
end

#transformation ⇒ `::Google::Cloud::Dlp::V2::PrimitiveTransformation`

Returns The specific transformation these stats apply to.

Returns:

(::Google::Cloud::Dlp::V2::PrimitiveTransformation) —
The specific transformation these stats apply to.

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3210

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

  # A collection that informs the user the number of times a particular
  # `TransformationResultCode` and error details occurred.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     Number of transformations counted by this result.
  # @!attribute [rw] code
  #   @return [::Google::Cloud::Dlp::V2::TransformationSummary::TransformationResultCode]
  #     Outcome of the transformation.
  # @!attribute [rw] details
  #   @return [::String]
  #     A place for warnings or errors to show up if a transformation didn't
  #     work as expected.
  class SummaryResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible outcomes of transformations.
  module TransformationResultCode
    # Unused
    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0

    # Transformation completed without an error.
    SUCCESS = 1

    # Transformation had an error.
    ERROR = 2
  end
end

#transformed_bytes ⇒ `::Integer`

Returns Total size in bytes that were transformed in some way.

Returns:

(::Integer) —
Total size in bytes that were transformed in some way.

# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3210

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

  # A collection that informs the user the number of times a particular
  # `TransformationResultCode` and error details occurred.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     Number of transformations counted by this result.
  # @!attribute [rw] code
  #   @return [::Google::Cloud::Dlp::V2::TransformationSummary::TransformationResultCode]
  #     Outcome of the transformation.
  # @!attribute [rw] details
  #   @return [::String]
  #     A place for warnings or errors to show up if a transformation didn't
  #     work as expected.
  class SummaryResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible outcomes of transformations.
  module TransformationResultCode
    # Unused
    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0

    # Transformation completed without an error.
    SUCCESS = 1

    # Transformation had an error.
    ERROR = 2
  end
end

Class: Google::Cloud::Dlp::V2::TransformationSummary

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#field ⇒ ::Google::Cloud::Dlp::V2::FieldId

#field_transformations ⇒ ::Array<::Google::Cloud::Dlp::V2::FieldTransformation>

#info_type ⇒ ::Google::Cloud::Dlp::V2::InfoType

#record_suppress ⇒ ::Google::Cloud::Dlp::V2::RecordSuppression

#results ⇒ ::Array<::Google::Cloud::Dlp::V2::TransformationSummary::SummaryResult>

#transformation ⇒ ::Google::Cloud::Dlp::V2::PrimitiveTransformation

#transformed_bytes ⇒ ::Integer

#field ⇒ `::Google::Cloud::Dlp::V2::FieldId`

#field_transformations ⇒ `::Array<::Google::Cloud::Dlp::V2::FieldTransformation>`

#info_type ⇒ `::Google::Cloud::Dlp::V2::InfoType`

#record_suppress ⇒ `::Google::Cloud::Dlp::V2::RecordSuppression`

#results ⇒ `::Array<::Google::Cloud::Dlp::V2::TransformationSummary::SummaryResult>`

#transformation ⇒ `::Google::Cloud::Dlp::V2::PrimitiveTransformation`

#transformed_bytes ⇒ `::Integer`