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:



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1193

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.
    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.



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1193

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.
    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:



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1193

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.
    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.



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb', line 1193

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.
    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