Class: Google::Cloud::SecurityCenter::V1::ListFindingsResponse

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

Overview

Response message for listing findings.

Defined Under Namespace

Classes: ListFindingsResult

Instance Attribute Summary collapse

Instance Attribute Details

#list_findings_results ⇒ ::Array<::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult>

Returns Findings matching the list request.

Returns:



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1455

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

  # Result containing the Finding and its StateChange.
  # @!attribute [rw] finding
  #   @return [::Google::Cloud::SecurityCenter::V1::Finding]
  #     Finding matching the search request.
  # @!attribute [rw] state_change
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::StateChange]
  #     State change of the finding between the points in time.
  # @!attribute [r] resource
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::Resource]
  #     Output only. Resource that is associated with this finding.
  class ListFindingsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information related to the Google Cloud resource that is
    # associated with this finding.
    # @!attribute [rw] name
    #   @return [::String]
    #     The full resource name of the resource. See:
    #     https://cloud.google.com/apis/design/resource_names#full_resource_name
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The human readable name of the resource.
    # @!attribute [rw] type
    #   @return [::String]
    #     The full resource type of the resource.
    # @!attribute [rw] project_name
    #   @return [::String]
    #     The full resource name of project that the resource belongs to.
    # @!attribute [rw] project_display_name
    #   @return [::String]
    #     The project ID that the resource belongs to.
    # @!attribute [rw] parent_name
    #   @return [::String]
    #     The full resource name of resource's parent.
    # @!attribute [rw] parent_display_name
    #   @return [::String]
    #     The human readable name of resource's parent.
    # @!attribute [rw] folders
    #   @return [::Array<::Google::Cloud::SecurityCenter::V1::Folder>]
    #     Contains a Folder message for each folder in the assets ancestry.
    #     The first folder is the deepest nested folder, and the last folder is
    #     the folder directly under the Organization.
    # @!attribute [rw] cloud_provider
    #   @return [::Google::Cloud::SecurityCenter::V1::CloudProvider]
    #     Indicates which cloud provider the finding is from.
    # @!attribute [rw] organization
    #   @return [::String]
    #     Indicates which organization / tenant the finding is for.
    # @!attribute [rw] service
    #   @return [::String]
    #     The service or resource provider associated with the resource.
    # @!attribute [rw] location
    #   @return [::String]
    #     The region or location of the service (if applicable).
    # @!attribute [rw] aws_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AwsMetadata]
    #     The AWS metadata associated with the finding.
    # @!attribute [rw] azure_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AzureMetadata]
    #     The Azure metadata associated with the finding.
    # @!attribute [rw] resource_path
    #   @return [::Google::Cloud::SecurityCenter::V1::ResourcePath]
    #     Provides the path to the resource within the resource hierarchy.
    # @!attribute [rw] resource_path_string
    #   @return [::String]
    #     A string representation of the resource path.
    #     For Google Cloud, it has the format of
    #     `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}`
    #     where there can be any number of folders.
    #     For AWS, it has the format of
    #     `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}`
    #     where there can be any number of organizational units.
    #     For Azure, it has the format of
    #     `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}`
    #     where there can be any number of management groups.
    class Resource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The change in state of the finding.
    #
    # When querying across two points in time this describes
    # the change in the finding between the two points: CHANGED, UNCHANGED,
    # ADDED, or REMOVED. Findings can not be deleted, so REMOVED implies that
    # the finding at timestamp does not match the filter specified, but it did
    # at timestamp - compare_duration. If there was no compare_duration
    # supplied in the request the state change will be: UNUSED
    module StateChange
      # State change is unused, this is the canonical default for this enum.
      UNUSED = 0

      # The finding has changed state in some way between the points in time
      # and existed at both points.
      CHANGED = 1

      # The finding has not changed state between the points in time and
      # existed at both points.
      UNCHANGED = 2

      # The finding was created between the points in time.
      ADDED = 3

      # The finding at timestamp does not match the filter specified, but it
      # did at timestamp - compare_duration.
      REMOVED = 4
    end
  end
end

#next_page_token ⇒ ::String

Returns Token to retrieve the next page of results, or empty if there are no more results.

Returns:

  • (::String) —

    Token to retrieve the next page of results, or empty if there are no more results.



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1455

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

  # Result containing the Finding and its StateChange.
  # @!attribute [rw] finding
  #   @return [::Google::Cloud::SecurityCenter::V1::Finding]
  #     Finding matching the search request.
  # @!attribute [rw] state_change
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::StateChange]
  #     State change of the finding between the points in time.
  # @!attribute [r] resource
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::Resource]
  #     Output only. Resource that is associated with this finding.
  class ListFindingsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information related to the Google Cloud resource that is
    # associated with this finding.
    # @!attribute [rw] name
    #   @return [::String]
    #     The full resource name of the resource. See:
    #     https://cloud.google.com/apis/design/resource_names#full_resource_name
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The human readable name of the resource.
    # @!attribute [rw] type
    #   @return [::String]
    #     The full resource type of the resource.
    # @!attribute [rw] project_name
    #   @return [::String]
    #     The full resource name of project that the resource belongs to.
    # @!attribute [rw] project_display_name
    #   @return [::String]
    #     The project ID that the resource belongs to.
    # @!attribute [rw] parent_name
    #   @return [::String]
    #     The full resource name of resource's parent.
    # @!attribute [rw] parent_display_name
    #   @return [::String]
    #     The human readable name of resource's parent.
    # @!attribute [rw] folders
    #   @return [::Array<::Google::Cloud::SecurityCenter::V1::Folder>]
    #     Contains a Folder message for each folder in the assets ancestry.
    #     The first folder is the deepest nested folder, and the last folder is
    #     the folder directly under the Organization.
    # @!attribute [rw] cloud_provider
    #   @return [::Google::Cloud::SecurityCenter::V1::CloudProvider]
    #     Indicates which cloud provider the finding is from.
    # @!attribute [rw] organization
    #   @return [::String]
    #     Indicates which organization / tenant the finding is for.
    # @!attribute [rw] service
    #   @return [::String]
    #     The service or resource provider associated with the resource.
    # @!attribute [rw] location
    #   @return [::String]
    #     The region or location of the service (if applicable).
    # @!attribute [rw] aws_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AwsMetadata]
    #     The AWS metadata associated with the finding.
    # @!attribute [rw] azure_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AzureMetadata]
    #     The Azure metadata associated with the finding.
    # @!attribute [rw] resource_path
    #   @return [::Google::Cloud::SecurityCenter::V1::ResourcePath]
    #     Provides the path to the resource within the resource hierarchy.
    # @!attribute [rw] resource_path_string
    #   @return [::String]
    #     A string representation of the resource path.
    #     For Google Cloud, it has the format of
    #     `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}`
    #     where there can be any number of folders.
    #     For AWS, it has the format of
    #     `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}`
    #     where there can be any number of organizational units.
    #     For Azure, it has the format of
    #     `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}`
    #     where there can be any number of management groups.
    class Resource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The change in state of the finding.
    #
    # When querying across two points in time this describes
    # the change in the finding between the two points: CHANGED, UNCHANGED,
    # ADDED, or REMOVED. Findings can not be deleted, so REMOVED implies that
    # the finding at timestamp does not match the filter specified, but it did
    # at timestamp - compare_duration. If there was no compare_duration
    # supplied in the request the state change will be: UNUSED
    module StateChange
      # State change is unused, this is the canonical default for this enum.
      UNUSED = 0

      # The finding has changed state in some way between the points in time
      # and existed at both points.
      CHANGED = 1

      # The finding has not changed state between the points in time and
      # existed at both points.
      UNCHANGED = 2

      # The finding was created between the points in time.
      ADDED = 3

      # The finding at timestamp does not match the filter specified, but it
      # did at timestamp - compare_duration.
      REMOVED = 4
    end
  end
end

#read_time ⇒ ::Google::Protobuf::Timestamp

Returns Time used for executing the list request.

Returns:



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1455

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

  # Result containing the Finding and its StateChange.
  # @!attribute [rw] finding
  #   @return [::Google::Cloud::SecurityCenter::V1::Finding]
  #     Finding matching the search request.
  # @!attribute [rw] state_change
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::StateChange]
  #     State change of the finding between the points in time.
  # @!attribute [r] resource
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::Resource]
  #     Output only. Resource that is associated with this finding.
  class ListFindingsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information related to the Google Cloud resource that is
    # associated with this finding.
    # @!attribute [rw] name
    #   @return [::String]
    #     The full resource name of the resource. See:
    #     https://cloud.google.com/apis/design/resource_names#full_resource_name
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The human readable name of the resource.
    # @!attribute [rw] type
    #   @return [::String]
    #     The full resource type of the resource.
    # @!attribute [rw] project_name
    #   @return [::String]
    #     The full resource name of project that the resource belongs to.
    # @!attribute [rw] project_display_name
    #   @return [::String]
    #     The project ID that the resource belongs to.
    # @!attribute [rw] parent_name
    #   @return [::String]
    #     The full resource name of resource's parent.
    # @!attribute [rw] parent_display_name
    #   @return [::String]
    #     The human readable name of resource's parent.
    # @!attribute [rw] folders
    #   @return [::Array<::Google::Cloud::SecurityCenter::V1::Folder>]
    #     Contains a Folder message for each folder in the assets ancestry.
    #     The first folder is the deepest nested folder, and the last folder is
    #     the folder directly under the Organization.
    # @!attribute [rw] cloud_provider
    #   @return [::Google::Cloud::SecurityCenter::V1::CloudProvider]
    #     Indicates which cloud provider the finding is from.
    # @!attribute [rw] organization
    #   @return [::String]
    #     Indicates which organization / tenant the finding is for.
    # @!attribute [rw] service
    #   @return [::String]
    #     The service or resource provider associated with the resource.
    # @!attribute [rw] location
    #   @return [::String]
    #     The region or location of the service (if applicable).
    # @!attribute [rw] aws_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AwsMetadata]
    #     The AWS metadata associated with the finding.
    # @!attribute [rw] azure_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AzureMetadata]
    #     The Azure metadata associated with the finding.
    # @!attribute [rw] resource_path
    #   @return [::Google::Cloud::SecurityCenter::V1::ResourcePath]
    #     Provides the path to the resource within the resource hierarchy.
    # @!attribute [rw] resource_path_string
    #   @return [::String]
    #     A string representation of the resource path.
    #     For Google Cloud, it has the format of
    #     `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}`
    #     where there can be any number of folders.
    #     For AWS, it has the format of
    #     `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}`
    #     where there can be any number of organizational units.
    #     For Azure, it has the format of
    #     `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}`
    #     where there can be any number of management groups.
    class Resource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The change in state of the finding.
    #
    # When querying across two points in time this describes
    # the change in the finding between the two points: CHANGED, UNCHANGED,
    # ADDED, or REMOVED. Findings can not be deleted, so REMOVED implies that
    # the finding at timestamp does not match the filter specified, but it did
    # at timestamp - compare_duration. If there was no compare_duration
    # supplied in the request the state change will be: UNUSED
    module StateChange
      # State change is unused, this is the canonical default for this enum.
      UNUSED = 0

      # The finding has changed state in some way between the points in time
      # and existed at both points.
      CHANGED = 1

      # The finding has not changed state between the points in time and
      # existed at both points.
      UNCHANGED = 2

      # The finding was created between the points in time.
      ADDED = 3

      # The finding at timestamp does not match the filter specified, but it
      # did at timestamp - compare_duration.
      REMOVED = 4
    end
  end
end

#total_size ⇒ ::Integer

Returns The total number of findings matching the query.

Returns:

  • (::Integer) —

    The total number of findings matching the query.



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1455

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

  # Result containing the Finding and its StateChange.
  # @!attribute [rw] finding
  #   @return [::Google::Cloud::SecurityCenter::V1::Finding]
  #     Finding matching the search request.
  # @!attribute [rw] state_change
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::StateChange]
  #     State change of the finding between the points in time.
  # @!attribute [r] resource
  #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::Resource]
  #     Output only. Resource that is associated with this finding.
  class ListFindingsResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information related to the Google Cloud resource that is
    # associated with this finding.
    # @!attribute [rw] name
    #   @return [::String]
    #     The full resource name of the resource. See:
    #     https://cloud.google.com/apis/design/resource_names#full_resource_name
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The human readable name of the resource.
    # @!attribute [rw] type
    #   @return [::String]
    #     The full resource type of the resource.
    # @!attribute [rw] project_name
    #   @return [::String]
    #     The full resource name of project that the resource belongs to.
    # @!attribute [rw] project_display_name
    #   @return [::String]
    #     The project ID that the resource belongs to.
    # @!attribute [rw] parent_name
    #   @return [::String]
    #     The full resource name of resource's parent.
    # @!attribute [rw] parent_display_name
    #   @return [::String]
    #     The human readable name of resource's parent.
    # @!attribute [rw] folders
    #   @return [::Array<::Google::Cloud::SecurityCenter::V1::Folder>]
    #     Contains a Folder message for each folder in the assets ancestry.
    #     The first folder is the deepest nested folder, and the last folder is
    #     the folder directly under the Organization.
    # @!attribute [rw] cloud_provider
    #   @return [::Google::Cloud::SecurityCenter::V1::CloudProvider]
    #     Indicates which cloud provider the finding is from.
    # @!attribute [rw] organization
    #   @return [::String]
    #     Indicates which organization / tenant the finding is for.
    # @!attribute [rw] service
    #   @return [::String]
    #     The service or resource provider associated with the resource.
    # @!attribute [rw] location
    #   @return [::String]
    #     The region or location of the service (if applicable).
    # @!attribute [rw] aws_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AwsMetadata]
    #     The AWS metadata associated with the finding.
    # @!attribute [rw] azure_metadata
    #   @return [::Google::Cloud::SecurityCenter::V1::AzureMetadata]
    #     The Azure metadata associated with the finding.
    # @!attribute [rw] resource_path
    #   @return [::Google::Cloud::SecurityCenter::V1::ResourcePath]
    #     Provides the path to the resource within the resource hierarchy.
    # @!attribute [rw] resource_path_string
    #   @return [::String]
    #     A string representation of the resource path.
    #     For Google Cloud, it has the format of
    #     `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}`
    #     where there can be any number of folders.
    #     For AWS, it has the format of
    #     `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}`
    #     where there can be any number of organizational units.
    #     For Azure, it has the format of
    #     `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}`
    #     where there can be any number of management groups.
    class Resource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The change in state of the finding.
    #
    # When querying across two points in time this describes
    # the change in the finding between the two points: CHANGED, UNCHANGED,
    # ADDED, or REMOVED. Findings can not be deleted, so REMOVED implies that
    # the finding at timestamp does not match the filter specified, but it did
    # at timestamp - compare_duration. If there was no compare_duration
    # supplied in the request the state change will be: UNUSED
    module StateChange
      # State change is unused, this is the canonical default for this enum.
      UNUSED = 0

      # The finding has changed state in some way between the points in time
      # and existed at both points.
      CHANGED = 1

      # The finding has not changed state between the points in time and
      # existed at both points.
      UNCHANGED = 2

      # The finding was created between the points in time.
      ADDED = 3

      # The finding at timestamp does not match the filter specified, but it
      # did at timestamp - compare_duration.
      REMOVED = 4
    end
  end
end