Security Command Center API . organizations . simulations . valuedResources

Instance Methods

attackPaths()

Returns the attackPaths Resource.

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Get the valued resource by name

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the valued resources for a set of simulation results and filter.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Get the valued resource by name

Args:
  name: string, Required. The name of this valued resource Valid format: `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource that is determined to have value to a user's system
  "displayName": "A String", # Human-readable name of the valued resource.
  "exposedScore": 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure.
  "name": "A String", # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789`
  "resource": "A String", # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource.
  "resourceType": "A String", # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource.
  "resourceValue": "A String", # How valuable this resource is.
  "resourceValueConfigsUsed": [ # List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100.
    { # Metadata about a ResourceValueConfig. For example, id and name.
      "name": "A String", # Resource value config name
    },
  ],
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the valued resources for a set of simulation results and filter.

Args:
  parent: string, Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` (required)
  filter: string, The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =
  orderBy: string, Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.
  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
  pageToken: string, The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for listing the valued resources for a given simulation.
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results.
  "totalSize": 42, # The estimated total number of results matching the query.
  "valuedResources": [ # The valued resources that the attack path simulation identified.
    { # A resource that is determined to have value to a user's system
      "displayName": "A String", # Human-readable name of the valued resource.
      "exposedScore": 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure.
      "name": "A String", # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789`
      "resource": "A String", # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource.
      "resourceType": "A String", # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource.
      "resourceValue": "A String", # How valuable this resource is.
      "resourceValueConfigsUsed": [ # List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100.
        { # Metadata about a ResourceValueConfig. For example, id and name.
          "name": "A String", # Resource value config name
        },
      ],
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.