Class: Google::Cloud::Dataplex::V1::Asset

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

Overview

An asset represents a cloud resource that is being managed within a lake as a member of a zone.

Defined Under Namespace

Classes: DiscoverySpec, DiscoveryStatus, LabelsEntry, ResourceSpec, ResourceStatus, SecurityStatus

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the asset was created.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. Description of the asset.

Returns:

  • (::String) —

    Optional. Description of the asset.



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#discovery_spec ⇒ ::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec

Returns Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#discovery_status ⇒ ::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus (readonly)

Returns Output only. Status of the discovery feature applied to data referenced by this asset.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Optional. User friendly display name.

Returns:

  • (::String) —

    Optional. User friendly display name.



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User defined labels for the asset.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User defined labels for the asset.



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.

Returns:

  • (::String) —

    Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#resource_spec ⇒ ::Google::Cloud::Dataplex::V1::Asset::ResourceSpec

Returns Required. Specification of the resource that is referenced by this asset.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#resource_status ⇒ ::Google::Cloud::Dataplex::V1::Asset::ResourceStatus (readonly)

Returns Output only. Status of the resource referenced by this asset.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#security_status ⇒ ::Google::Cloud::Dataplex::V1::Asset::SecurityStatus (readonly)

Returns Output only. Status of the security policy applied to resource referenced by this asset.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::Dataplex::V1::State (readonly)

Returns Output only. Current state of the asset.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.

Returns:

  • (::String) —

    Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the asset was last updated.

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 562

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

  # Security policy status of the asset. Data security policy, i.e., readers,
  # writers & owners, should be specified in the lake/zone/asset IAM policy.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus::State]
  #     The current state of the security policy applied to the attached
  #     resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  class SecurityStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the security policy.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Security policy has been successfully applied to the attached resource.
      READY = 1

      # Security policy is in the process of being applied to the attached
      # resource.
      APPLYING = 2

      # Security policy could not be applied to the attached resource due to
      # errors.
      ERROR = 3
    end
  end

  # Settings to manage the metadata discovery and publishing for an asset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to include
  #     during discovery if only a subset of the data should considered.  For
  #     Cloud Storage bucket assets, these are interpreted as glob patterns used
  #     to match object names. For BigQuery dataset assets, these are interpreted
  #     as patterns to match table names.
  # @!attribute [rw] exclude_patterns
  #   @return [::Array<::String>]
  #     Optional. The list of patterns to apply for selecting data to exclude
  #     during discovery.  For Cloud Storage bucket assets, these are interpreted
  #     as glob patterns used to match object names. For BigQuery dataset assets,
  #     these are interpreted as patterns to match table names.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::String]
  #     Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
  #     running discovery periodically. Successive discovery runs must be
  #     scheduled at least 60 minutes apart. The default value is to run
  #     discovery every 60 minutes. To explicitly set a timezone to the cron
  #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
  #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
  #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
  #     * * * *`, or `TZ=America/New_York 1 * * * *`.
  class DiscoverySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describe CSV and similar semi-structured data formats.
    # @!attribute [rw] header_rows
    #   @return [::Integer]
    #     Optional. The number of rows to interpret as header rows that should be
    #     skipped when reading data rows.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. The delimiter being used to separate values. This defaults to
    #     ','.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for CSV data.
    #     If true, all columns will be registered as strings.
    class CsvOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describe JSON data format.
    # @!attribute [rw] encoding
    #   @return [::String]
    #     Optional. The character encoding of the data. The default is UTF-8.
    # @!attribute [rw] disable_type_inference
    #   @return [::Boolean]
    #     Optional. Whether to disable the inference of data type for Json data.
    #     If true, all columns will be registered as their primitive types
    #     (strings, number or boolean).
    class JsonOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Identifies the cloud resource that is referenced by this asset.
  # @!attribute [rw] name
  #   @return [::String]
  #     Immutable. Relative name of the cloud resource that contains the data
  #     that is being managed within a lake. For example:
  #       `projects/{project_number}/buckets/{bucket_id}`
  #       `projects/{project_number}/datasets/{dataset_id}`
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
  #     Required. Immutable. Type of resource.
  # @!attribute [rw] read_access_mode
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
  #     Optional. Determines how read permissions are handled for each asset and
  #     their associated tables. Only available to storage buckets assets.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of resource.
    module Type
      # Type not specified.
      TYPE_UNSPECIFIED = 0

      # Cloud Storage bucket.
      STORAGE_BUCKET = 1

      # BigQuery dataset.
      BIGQUERY_DATASET = 2
    end

    # Access Mode determines how data stored within the resource is read. This
    # is only applicable to storage bucket assets.
    module AccessMode
      # Access mode unspecified.
      ACCESS_MODE_UNSPECIFIED = 0

      # Default. Data is accessed directly using storage APIs.
      DIRECT = 1

      # Data is accessed through a managed interface using BigQuery APIs.
      MANAGED = 2
    end
  end

  # Status of the resource referenced by an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceStatus::State]
  #     The current state of the managed resource.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [r] managed_access_identity
  #   @return [::String]
  #     Output only. Service account associated with the BigQuery Connection.
  class ResourceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of a resource.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # Resource does not have any errors.
      READY = 1

      # Resource has errors.
      ERROR = 2
    end
  end

  # Status of discovery for an asset.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::State]
  #     The current status of the discovery feature.
  # @!attribute [rw] message
  #   @return [::String]
  #     Additional information about the current state.
  # @!attribute [rw] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last update time of the status.
  # @!attribute [rw] last_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of the last discovery run.
  # @!attribute [rw] stats
  #   @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus::Stats]
  #     Data Stats of the asset reported by discovery.
  # @!attribute [rw] last_run_duration
  #   @return [::Google::Protobuf::Duration]
  #     The duration of the last discovery run.
  class DiscoveryStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The aggregated data statistics for the asset reported by discovery.
    # @!attribute [rw] data_items
    #   @return [::Integer]
    #     The count of data items within the referenced resource.
    # @!attribute [rw] data_size
    #   @return [::Integer]
    #     The number of stored data bytes within the referenced resource.
    # @!attribute [rw] tables
    #   @return [::Integer]
    #     The count of table entities within the referenced resource.
    # @!attribute [rw] filesets
    #   @return [::Integer]
    #     The count of fileset entities within the referenced resource.
    class Stats
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Current state of discovery.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Discovery for the asset is scheduled.
      SCHEDULED = 1

      # Discovery for the asset is running.
      IN_PROGRESS = 2

      # Discovery for the asset is currently paused (e.g. due to a lack
      # of available resources). It will be automatically resumed.
      PAUSED = 3

      # Discovery for the asset is disabled.
      DISABLED = 5
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end