close()

Close httplib2 connections.

delete(name, requestId=None, x__xgafv=None)

Deletes a single Execution.

Args:
name: string, Required. Name of the resource (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets details of a single Execution.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing Execution object
  "endTime": "A String", # Output only. [Output only] End time stamp
  "evaluationId": "A String", # Output only. [Output only] Evaluation ID
  "externalDataSources": [ # Optional. External data sources
    { # Message for external data sources
      "assetType": "A String", # Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule
      "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data
      "type": "A String", # Required. Type of external data source
      "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}
    },
  ],
  "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp
  "labels": { # Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}
  "notices": [ # Output only. Additional information generated by the execution
    { # Message for additional information generated by the execution
      "message": "A String", # Output only. Message of the notice
    },
  ],
  "resultSummary": { # Message for execution summary # Output only. [Output only] Result summary
    "failures": "A String", # Output only. Number of failures
    "newFailures": "A String", # Output only. Number of new failures compared to the previous execution
    "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution
  },
  "ruleResults": [ # Output only. execution result summary per rule
    { # Message for execution result summary per rule
      "message": "A String", # Execution message, if any
      "resultCount": "A String", # Number of violations
      "rule": "A String", # rule name
      "scannedResourceCount": "A String", # Number of total scanned resources
      "state": "A String", # Output only. The execution status
    },
  ],
  "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.
  "startTime": "A String", # Output only. [Output only] Start time stamp
  "state": "A String", # Output only. [Output only] State
}

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

Lists Executions in a given project and location.

Args:
  parent: string, Required. The resource prefix of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}' (required)
  filter: string, Filtering results
  orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing Executions
  "executions": [ # The list of Execution
    { # Message describing Execution object
      "endTime": "A String", # Output only. [Output only] End time stamp
      "evaluationId": "A String", # Output only. [Output only] Evaluation ID
      "externalDataSources": [ # Optional. External data sources
        { # Message for external data sources
          "assetType": "A String", # Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule
          "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data
          "type": "A String", # Required. Type of external data source
          "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}
        },
      ],
      "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp
      "labels": { # Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}
      "notices": [ # Output only. Additional information generated by the execution
        { # Message for additional information generated by the execution
          "message": "A String", # Output only. Message of the notice
        },
      ],
      "resultSummary": { # Message for execution summary # Output only. [Output only] Result summary
        "failures": "A String", # Output only. Number of failures
        "newFailures": "A String", # Output only. Number of new failures compared to the previous execution
        "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution
      },
      "ruleResults": [ # Output only. execution result summary per rule
        { # Message for execution result summary per rule
          "message": "A String", # Execution message, if any
          "resultCount": "A String", # Number of violations
          "rule": "A String", # rule name
          "scannedResourceCount": "A String", # Number of total scanned resources
          "state": "A String", # Output only. The execution status
        },
      ],
      "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.
      "startTime": "A String", # Output only. [Output only] Start time stamp
      "state": "A String", # Output only. [Output only] State
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

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.

run(name, body=None, x__xgafv=None)

Creates a new Execution in a given project and location.

Args:
name: string, Required. The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}' (required)
body: object, The request body.
The object takes the form of:

{ # Message for creating a Execution
"execution": { # Message describing Execution object # Required. The resource being created
"endTime": "A String", # Output only. [Output only] End time stamp
"evaluationId": "A String", # Output only. [Output only] Evaluation ID
"externalDataSources": [ # Optional. External data sources
{ # Message for external data sources
"assetType": "A String", # Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule
"name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data
"type": "A String", # Required. Type of external data source
"uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}
},
],
"inventoryTime": "A String", # Output only. [Output only] Inventory time stamp
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}
"notices": [ # Output only. Additional information generated by the execution
{ # Message for additional information generated by the execution
"message": "A String", # Output only. Message of the notice
},
],
"resultSummary": { # Message for execution summary # Output only. [Output only] Result summary
"failures": "A String", # Output only. Number of failures
"newFailures": "A String", # Output only. Number of new failures compared to the previous execution
"newFixes": "A String", # Output only. Number of new fixes compared to the previous execution
},
"ruleResults": [ # Output only. execution result summary per rule
{ # Message for execution result summary per rule
"message": "A String", # Execution message, if any
"resultCount": "A String", # Number of violations
"rule": "A String", # rule name
"scannedResourceCount": "A String", # Number of total scanned resources
"state": "A String", # Output only. The execution status
},
],
"runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.
"startTime": "A String", # Output only. [Output only] Start time stamp
"state": "A String", # Output only. [Output only] State
},
"executionId": "A String", # Required. Id of the requesting object If auto-generating Id server-side, remove this field and execution_id from the method_signature of Create RPC
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

Workload Manager API . projects . locations . evaluations . executions

Instance Methods

Method Details