close()

Close httplib2 connections.

create(parent, body=None, evaluationId=None, requestId=None, x__xgafv=None)

Creates a new Evaluation in a given project and location.

Args:
parent: string, Required. The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}` (required)
body: object, The request body.
The object takes the form of:

{ # LINT.IfChange Message describing Evaluation object
"bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
"createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
"destinationDataset": "A String", # Optional. destination dataset to save evaluation results
},
"createTime": "A String", # Output only. [Output only] Create time stamp
"customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
"description": "A String", # Description of the Evaluation
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
"resourceFilter": { # Message describing resource filters # annotations as key value pairs
"gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
"serviceAccounts": [ # Service account of compute engine
"A String",
],
},
"inclusionLabels": { # The label used for filter resource
"a_key": "A String",
},
"resourceIdPatterns": [ # The id pattern for filter resource
"A String",
],
"scopes": [ # The scopes of evaluation resource
"A String",
],
},
"resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
"rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
"A String",
],
"state": "A String", # State of the resource
},
"ruleNames": [ # the name of the rule
"A String",
],
"ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
"A String",
],
"schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
"updateTime": "A String", # Output only. [Output only] Update time stamp
}

evaluationId: string, Required. Id of the requesting object
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 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.
},
}

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

Deletes a single Evaluation.

Args:
name: string, Required. Name of the resource (required)
force: boolean, Optional. Followed the best practice from https://aip.dev/135#cascading-delete
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 Evaluation.

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:

    { # LINT.IfChange Message describing Evaluation object
  "bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
    "createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
    "destinationDataset": "A String", # Optional. destination dataset to save evaluation results
  },
  "createTime": "A String", # Output only. [Output only] Create time stamp
  "customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
  "description": "A String", # Description of the Evaluation
  "labels": { # Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
  "resourceFilter": { # Message describing resource filters # annotations as key value pairs
    "gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
      "serviceAccounts": [ # Service account of compute engine
        "A String",
      ],
    },
    "inclusionLabels": { # The label used for filter resource
      "a_key": "A String",
    },
    "resourceIdPatterns": [ # The id pattern for filter resource
      "A String",
    ],
    "scopes": [ # The scopes of evaluation resource
      "A String",
    ],
  },
  "resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
    "rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
      "A String",
    ],
    "state": "A String", # State of the resource
  },
  "ruleNames": [ # the name of the rule
    "A String",
  ],
  "ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
    "A String",
  ],
  "schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
  "updateTime": "A String", # Output only. [Output only] Update time stamp
}

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

Lists Evaluations in a given project and location.

Args:
  parent: string, Required. Parent value for ListEvaluationsRequest (required)
  filter: string, Filter to be applied when listing the evaluation results.
  orderBy: string, Hint for how to order the results
  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 Evaluations
  "evaluations": [ # The list of Evaluation
    { # LINT.IfChange Message describing Evaluation object
      "bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
        "createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
        "destinationDataset": "A String", # Optional. destination dataset to save evaluation results
      },
      "createTime": "A String", # Output only. [Output only] Create time stamp
      "customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
      "description": "A String", # Description of the Evaluation
      "labels": { # Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
      "resourceFilter": { # Message describing resource filters # annotations as key value pairs
        "gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
          "serviceAccounts": [ # Service account of compute engine
            "A String",
          ],
        },
        "inclusionLabels": { # The label used for filter resource
          "a_key": "A String",
        },
        "resourceIdPatterns": [ # The id pattern for filter resource
          "A String",
        ],
        "scopes": [ # The scopes of evaluation resource
          "A String",
        ],
      },
      "resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
        "rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
          "A String",
        ],
        "state": "A String", # State of the resource
      },
      "ruleNames": [ # the name of the rule
        "A String",
      ],
      "ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
        "A String",
      ],
      "schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
      "updateTime": "A String", # Output only. [Output only] Update time stamp
    },
  ],
  "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.

Workload Manager API . projects . locations . evaluations

Instance Methods

Method Details