{ "baseUrl": "https://workloadmanager.googleapis.com/", "ownerDomain": "google.com", "basePath": "", "title": "Workload Manager API", "fullyEncodeReservedExpansion": true, "name": "workloadmanager", "version_module": true, "schemas": { "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "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}`.", "type": "string" }, "metadata": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "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.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "Status": { "id": "Status", "description": "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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "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.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Empty": { "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "ListEvaluationsResponse": { "id": "ListEvaluationsResponse", "description": "Response message for the ListEvaluations RPC.", "type": "object", "properties": { "evaluations": { "description": "The list of evaluations.", "type": "array", "items": { "$ref": "Evaluation" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Evaluation": { "id": "Evaluation", "description": "Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources.", "type": "object", "properties": { "name": { "description": "Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.", "type": "string" }, "description": { "description": "Description of the Evaluation.", "type": "string" }, "resourceFilter": { "description": "Resource filter for an evaluation defining the scope of resources to be evaluated.", "$ref": "ResourceFilter" }, "ruleNames": { "description": "The names of the rules used for this evaluation.", "type": "array", "items": { "type": "string" } }, "resourceStatus": { "description": "Output only. [Output only] The current lifecycle state of the evaluation resource.", "readOnly": true, "$ref": "ResourceStatus" }, "createTime": { "description": "Output only. [Output only] Create time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. [Output only] Update time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "labels": { "description": "Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "schedule": { "description": "Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * `0 */1 * * *` # Hourly * `0 */6 * * *` # Every 6 hours * `0 */12 * * *` # Every 12 hours * `0 0 */1 * *` # Daily * `0 0 */7 * *` # Weekly * `0 0 */14 * *` # Every 14 days * `0 0 1 */1 *` # Monthly", "type": "string" }, "customRulesBucket": { "description": "The Cloud Storage bucket name for custom rules.", "type": "string" }, "evaluationType": { "description": "Evaluation type.", "type": "string", "enumDescriptions": [ "Not specified.", "SAP best practices.", "SQL best practices.", "Customized best practices." ], "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "SAP", "SQL_SERVER", "OTHER" ] }, "bigQueryDestination": { "description": "Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery.", "$ref": "BigQueryDestination" }, "kmsKey": { "description": "Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. The key will be used for CMEK encryption of the evaluation resource.", "type": "string" } } }, "ResourceFilter": { "id": "ResourceFilter", "description": "Resource filter for an evaluation defining the scope of resources to be evaluated.", "type": "object", "properties": { "scopes": { "description": "The scopes of evaluation resource. Format: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", "type": "array", "items": { "type": "string" } }, "resourceIdPatterns": { "description": "The pattern to filter resources by their id For example, a pattern of \".*prod-cluster.*\" will match all resources that contain \"prod-cluster\" in their ID.", "type": "array", "items": { "type": "string" } }, "inclusionLabels": { "description": "Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying `{ \"env\": \"prod\", \"database\": \"nosql\" }` will only include resources that have labels `env=prod` and `database=nosql`.", "type": "object", "additionalProperties": { "type": "string" } }, "gceInstanceFilter": { "description": "Filter compute engine resources.", "$ref": "GceInstanceFilter" } } }, "GceInstanceFilter": { "id": "GceInstanceFilter", "description": "A filter for matching Compute Engine instances.", "type": "object", "properties": { "serviceAccounts": { "description": "If non-empty, only Compute Engine instances associated with at least one of the provided service accounts will be included in the evaluation.", "type": "array", "items": { "type": "string" } } } }, "ResourceStatus": { "id": "ResourceStatus", "description": "The lifecycle status of an Evaluation resource.", "type": "object", "properties": { "state": { "description": "State of the Evaluation resource.", "type": "string", "enumDescriptions": [ "The state has not been populated in this message.", "Resource has an active Create operation.", "Resource has no outstanding operations on it or has active Update operations.", "Resource has an active Delete operation." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING" ] } } }, "BigQueryDestination": { "id": "BigQueryDestination", "description": "BigQuery destination for evaluation results.", "type": "object", "properties": { "destinationDataset": { "description": "Optional. Destination dataset to save evaluation results.", "type": "string" }, "createNewResultsTable": { "description": "Optional. Determines if a new results table will be created when an Execution is created.", "type": "boolean" } } }, "ListExecutionsResponse": { "id": "ListExecutionsResponse", "description": "Response message for the ListExecutions RPC.", "type": "object", "properties": { "executions": { "description": "The list of Execution.", "type": "array", "items": { "$ref": "Execution" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Execution": { "id": "Execution", "description": "Execution that represents a single run of an Evaluation.", "type": "object", "properties": { "name": { "description": "The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}.", "type": "string" }, "startTime": { "description": "Output only. [Output only] Start time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. [Output only] End time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "inventoryTime": { "description": "Output only. [Output only] Inventory time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. [Output only] State.", "readOnly": true, "type": "string", "enumDescriptions": [ "State of execution is unspecified.", "The execution is running in backend service.", "The execution run succeeded.", "The execution run failed." ], "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "FAILED" ] }, "evaluationId": { "description": "Output only. [Output only] Evaluation ID.", "readOnly": true, "type": "string" }, "labels": { "description": "Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "runType": { "description": "Type which represents whether the execution executed directly by user or scheduled according to the `Evaluation.schedule` field.", "type": "string", "enumDescriptions": [ "Type of execution is unspecified.", "Type of execution is one time.", "Type of execution is scheduled." ], "enum": [ "TYPE_UNSPECIFIED", "ONE_TIME", "SCHEDULED" ] }, "ruleResults": { "description": "Output only. Execution result summary per rule.", "readOnly": true, "type": "array", "items": { "$ref": "RuleExecutionResult" } }, "externalDataSources": { "description": "Optional. External data sources.", "type": "array", "items": { "$ref": "ExternalDataSources" } }, "notices": { "description": "Output only. Additional information generated by the execution.", "readOnly": true, "type": "array", "items": { "$ref": "Notice" } }, "engine": { "description": "Optional. Engine.", "type": "string", "enumDescriptions": [ "The original CG.", "SlimCG / Scanner.", "Evaluation Engine V2." ], "enum": [ "ENGINE_UNSPECIFIED", "ENGINE_SCANNER", "V2" ] }, "resultSummary": { "description": "Output only. [Output only] Result summary for the execution.", "readOnly": true, "$ref": "Summary" } } }, "RuleExecutionResult": { "id": "RuleExecutionResult", "description": "Execution result summary per rule.", "type": "object", "properties": { "rule": { "description": "Rule name as plain text like `sap-hana-configured`.", "type": "string" }, "state": { "description": "Output only. The execution status.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unknown state", "Execution completed successfully", "Execution completed with failures", "Execution was not executed" ], "enum": [ "STATE_UNSPECIFIED", "STATE_SUCCESS", "STATE_FAILURE", "STATE_SKIPPED" ] }, "message": { "description": "Execution message, if any.", "type": "string" }, "resultCount": { "description": "Number of violations.", "type": "string", "format": "int64" }, "scannedResourceCount": { "description": "Number of total scanned resources.", "type": "string", "format": "int64" } } }, "ExternalDataSources": { "id": "ExternalDataSources", "description": "External data sources for an execution.", "type": "object", "properties": { "name": { "description": "Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data.", "type": "string" }, "uri": { "description": "Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}.", "type": "string" }, "type": { "description": "Required. Type of external data source.", "type": "string", "enumDescriptions": [ "Unknown type.", "BigQuery table." ], "enum": [ "TYPE_UNSPECIFIED", "BIG_QUERY_TABLE" ] }, "assetType": { "description": "Required. The asset type of the external data source. This can be a supported Cloud Asset Inventory asset type (see https://cloud.google.com/asset-inventory/docs/supported-asset-types) to override the default asset type, or it can be a custom type defined by the user.", "type": "string" } } }, "Notice": { "id": "Notice", "description": "Additional information generated by an execution.", "type": "object", "properties": { "message": { "description": "Output only. Message of the notice.", "readOnly": true, "type": "string" } } }, "Summary": { "id": "Summary", "description": "Execution summary.", "type": "object", "properties": { "failures": { "description": "Output only. Number of failures.", "readOnly": true, "type": "string", "format": "int64" }, "newFailures": { "description": "Output only. Number of new failures compared to the previous execution.", "readOnly": true, "type": "string", "format": "int64" }, "newFixes": { "description": "Output only. Number of new fixes compared to the previous execution.", "readOnly": true, "type": "string", "format": "int64" } } }, "RunEvaluationRequest": { "id": "RunEvaluationRequest", "description": "Request message for the RunEvaluation RPC.", "type": "object", "properties": { "executionId": { "description": "Required. ID of the execution which will be created.", "type": "string" }, "execution": { "description": "Required. The resource being created.", "$ref": "Execution" }, "requestId": { "description": "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).", "type": "string" } } }, "ListExecutionResultsResponse": { "id": "ListExecutionResultsResponse", "description": "Response message for the ListExecutionResults RPC.", "type": "object", "properties": { "executionResults": { "description": "The versions from the specified publisher.", "type": "array", "items": { "$ref": "ExecutionResult" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "ExecutionResult": { "id": "ExecutionResult", "description": "The result of an execution.", "type": "object", "properties": { "violationMessage": { "description": "The violation message of an execution.", "type": "string" }, "severity": { "description": "The severity of violation.", "type": "string" }, "rule": { "description": "The rule that is violated in an evaluation.", "type": "string" }, "documentationUrl": { "description": "The URL for the documentation of the rule.", "type": "string" }, "resource": { "description": "The resource that violates the rule.", "$ref": "Resource" }, "violationDetails": { "description": "The details of violation in an evaluation result.", "$ref": "ViolationDetails" }, "commands": { "description": "The commands to remediate the violation.", "type": "array", "items": { "$ref": "Command" } }, "type": { "description": "Execution result type of the scanned resource.", "type": "string", "enumDescriptions": [ "Unknown state.", "Resource successfully passed the rule.", "Resource violated the rule." ], "enum": [ "TYPE_UNSPECIFIED", "TYPE_PASSED", "TYPE_VIOLATED" ] } } }, "Resource": { "id": "Resource", "description": "Resource in execution result.", "type": "object", "properties": { "type": { "description": "The type of resource.", "type": "string" }, "name": { "description": "The name of the resource.", "type": "string" }, "serviceAccount": { "description": "The service account associated with the resource.", "type": "string" } } }, "ViolationDetails": { "id": "ViolationDetails", "description": "The violation in an evaluation result.", "type": "object", "properties": { "asset": { "description": "The name of the asset.", "type": "string" }, "serviceAccount": { "description": "The service account associated with the resource.", "type": "string" }, "observed": { "description": "Details of the violation.", "type": "object", "additionalProperties": { "type": "string" } }, "ruleOutput": { "description": "Output only. The rule output of the violation.", "readOnly": true, "type": "array", "items": { "$ref": "RuleOutput" } } } }, "RuleOutput": { "id": "RuleOutput", "description": "The rule output of the violation.", "type": "object", "properties": { "details": { "description": "Output only. Violation details generated by rule.", "readOnly": true, "type": "object", "additionalProperties": { "type": "string" } }, "message": { "description": "Output only. The message generated by rule.", "readOnly": true, "type": "string" } } }, "Command": { "id": "Command", "description": "Command specifies the type of command to execute.", "type": "object", "properties": { "agentCommand": { "description": "AgentCommand specifies a one-time executable program for the agent to run.", "$ref": "AgentCommand" }, "shellCommand": { "description": "ShellCommand is invoked via the agent's command line executor.", "$ref": "ShellCommand" } } }, "AgentCommand": { "id": "AgentCommand", "description": "An AgentCommand specifies a one-time executable program for the agent to run.", "type": "object", "properties": { "command": { "description": "The name of the agent one-time executable that will be invoked.", "type": "string" }, "parameters": { "description": "A map of key/value pairs that can be used to specify additional one-time executable settings.", "type": "object", "additionalProperties": { "type": "string" } } } }, "ShellCommand": { "id": "ShellCommand", "description": "A ShellCommand is invoked via the agent's command line executor.", "type": "object", "properties": { "command": { "description": "The name of the command to be executed.", "type": "string" }, "args": { "description": "Arguments to be passed to the command.", "type": "string" }, "timeoutSeconds": { "description": "Optional. If not specified, the default timeout is 60 seconds.", "type": "integer", "format": "int32" } } }, "ListRulesResponse": { "id": "ListRulesResponse", "description": "Response message for the ListRules RPC.", "type": "object", "properties": { "rules": { "description": "All rules in response.", "type": "array", "items": { "$ref": "Rule" } } } }, "Rule": { "id": "Rule", "description": "A rule to be evaluated.", "type": "object", "properties": { "name": { "description": "Rule name.", "type": "string" }, "revisionId": { "description": "Output only. The version of the rule.", "readOnly": true, "type": "string" }, "displayName": { "description": "The name display in UI.", "type": "string" }, "description": { "description": "Describe rule in plain language.", "type": "string" }, "severity": { "description": "The severity of the rule.", "type": "string" }, "primaryCategory": { "description": "The primary category.", "type": "string" }, "secondaryCategory": { "description": "The secondary category.", "type": "string" }, "errorMessage": { "description": "The message template for rule.", "type": "string" }, "uri": { "description": "The document url for the rule.", "type": "string" }, "remediation": { "description": "The remediation for the rule.", "type": "string" }, "tags": { "description": "List of user-defined tags.", "type": "array", "items": { "type": "string" } }, "ruleType": { "description": "The type of the rule.", "type": "string", "enumDescriptions": [ "Not specified.", "Baseline rules.", "Custom rules." ], "enum": [ "RULE_TYPE_UNSPECIFIED", "BASELINE", "CUSTOM" ] }, "assetType": { "description": "The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.", "type": "string" } } }, "ListScannedResourcesResponse": { "id": "ListScannedResourcesResponse", "description": "Response message for the ListScannedResources RPC.", "type": "object", "properties": { "scannedResources": { "description": "All scanned resources in response.", "type": "array", "items": { "$ref": "ScannedResource" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "ScannedResource": { "id": "ScannedResource", "description": "A scanned resource.", "type": "object", "properties": { "resource": { "description": "Resource name.", "type": "string" }, "type": { "description": "Resource type.", "type": "string" } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "WriteInsightRequest": { "id": "WriteInsightRequest", "description": "Request for sending the data insights.", "type": "object", "properties": { "insight": { "description": "Required. The metrics data details.", "$ref": "Insight" }, "requestId": { "description": "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).", "type": "string" }, "agentVersion": { "description": "Optional. The agent version collected this data point.", "type": "string" } } }, "Insight": { "id": "Insight", "description": "A presentation of host resource usage where the workload runs.", "type": "object", "properties": { "sentTime": { "description": "Output only. [Output only] Create time stamp", "readOnly": true, "type": "string", "format": "google-datetime" }, "sapValidation": { "description": "The insights data for the SAP workload validation.", "$ref": "SapValidation" }, "sapDiscovery": { "description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes.", "$ref": "SapDiscovery" }, "sqlserverValidation": { "description": "The insights data for the sqlserver workload validation.", "$ref": "SqlserverValidation" }, "torsoValidation": { "description": "The insights data for workload validation of torso workloads.", "$ref": "TorsoValidation" }, "agentStatus": { "description": "The insights data for the agent status.", "$ref": "AgentStatus" }, "openShiftValidation": { "description": "The insights data for the OpenShift workload validation.", "$ref": "OpenShiftValidation" }, "instanceId": { "description": "Optional. The instance id where the insight is generated from", "type": "string" } } }, "SapValidation": { "id": "SapValidation", "description": "A presentation of SAP workload insight. The schema of SAP workloads validation related data.", "type": "object", "properties": { "validationDetails": { "description": "Optional. A list of SAP validation metrics data.", "type": "array", "items": { "$ref": "SapValidationValidationDetail" } }, "projectId": { "description": "Required. The project_id of the cloud project that the Insight data comes from.", "type": "string" }, "zone": { "description": "Optional. The zone of the instance that the Insight data comes from.", "type": "string" } } }, "SapValidationValidationDetail": { "id": "SapValidationValidationDetail", "description": "Message describing the SAP validation metrics.", "type": "object", "properties": { "sapValidationType": { "description": "Optional. The SAP system that the validation data is from.", "type": "string", "enumDescriptions": [ "Unspecified type.", "The SYSTEM validation type collects underlying system data from the VM.", "The COROSYNC validation type collects Corosync configuration and runtime data. Corosync enables servers to interact as a HA cluster.", "The PACEMAKER validation type collects Pacemaker configuration data. Pacemaker is a high-availability cluster resource manager.", "The HANA validation type collects HANA configuration data. SAP HANA is an in-memory, column-oriented, relational database management system.", "The NETWEAVER validation type collects NetWeaver configuration data. SAP NetWeaver is a software stack for many of SAP SE's applications.", "The HANA_SECURITY validation type collects HANA configuration data as it relates to SAP security best practices.", "The CUSTOM validation type collects any customer-defined data that does not fall into any of the other categories of validations." ], "enum": [ "SAP_VALIDATION_TYPE_UNSPECIFIED", "SYSTEM", "COROSYNC", "PACEMAKER", "HANA", "NETWEAVER", "HANA_SECURITY", "CUSTOM" ] }, "details": { "description": "Optional. The pairs of metrics data: field name & field value.", "type": "object", "additionalProperties": { "type": "string" } }, "isPresent": { "description": "Optional. Was there a SAP system detected for this validation type.", "type": "boolean" } } }, "SapDiscovery": { "id": "SapDiscovery", "description": "The schema of SAP system discovery data.", "type": "object", "properties": { "metadata": { "description": "Optional. The metadata for SAP system discovery data.", "$ref": "SapDiscoveryMetadata" }, "databaseLayer": { "description": "Required. An SAP System must have a database.", "$ref": "SapDiscoveryComponent" }, "applicationLayer": { "description": "Optional. An SAP system may run without an application layer.", "$ref": "SapDiscoveryComponent" }, "systemId": { "description": "Output only. A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system.", "readOnly": true, "type": "string" }, "updateTime": { "description": "Required. Unix timestamp this system has been updated last.", "type": "string", "format": "google-datetime" }, "projectNumber": { "description": "Optional. The GCP project number that this SapSystem belongs to.", "type": "string" }, "workloadProperties": { "description": "Optional. The properties of the workload.", "$ref": "SapDiscoveryWorkloadProperties" }, "useDrReconciliation": { "description": "Optional. Whether to use DR reconciliation or not.", "type": "boolean" } } }, "SapDiscoveryMetadata": { "id": "SapDiscoveryMetadata", "description": "Message describing SAP discovery system metadata", "type": "object", "properties": { "definedSystem": { "description": "Optional. Customer defined, something like \"E-commerce pre prod\"", "type": "string" }, "sapProduct": { "description": "Optional. This SAP product name", "type": "string" }, "environmentType": { "description": "Optional. Should be \"prod\", \"QA\", \"dev\", \"staging\", etc.", "type": "string" }, "customerRegion": { "description": "Optional. Customer region string for customer's use. Does not represent GCP region.", "type": "string" } } }, "SapDiscoveryComponent": { "id": "SapDiscoveryComponent", "description": "Message describing the system component.", "type": "object", "properties": { "resources": { "description": "Optional. The resources in a component.", "type": "array", "items": { "$ref": "SapDiscoveryResource" } }, "applicationProperties": { "description": "Optional. The component is a SAP application.", "$ref": "SapDiscoveryComponentApplicationProperties" }, "databaseProperties": { "description": "Optional. The component is a SAP database.", "$ref": "SapDiscoveryComponentDatabaseProperties" }, "hostProject": { "description": "Required. Pantheon Project in which the resources reside.", "type": "string" }, "sid": { "description": "Optional. The SAP identifier, used by the SAP software and helps differentiate systems for customers.", "type": "string" }, "topologyType": { "description": "Optional. The detected topology of the component.", "type": "string", "enumDescriptions": [ "Unspecified topology.", "A scale-up single node system.", "A scale-out multi-node system." ], "enum": [ "TOPOLOGY_TYPE_UNSPECIFIED", "TOPOLOGY_SCALE_UP", "TOPOLOGY_SCALE_OUT" ] }, "haHosts": { "description": "Optional. A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.", "type": "array", "items": { "type": "string" } }, "replicationSites": { "description": "Optional. A list of replication sites used in Disaster Recovery (DR) configurations.", "type": "array", "items": { "$ref": "SapDiscoveryComponentReplicationSite" } }, "region": { "description": "Optional. The region this component's resources are primarily located in.", "type": "string" } } }, "SapDiscoveryResource": { "id": "SapDiscoveryResource", "description": "Message describing a resource.", "type": "object", "properties": { "resourceType": { "description": "Required. The type of this resource.", "type": "string", "enumDescriptions": [ "Undefined resource type.", "This is a compute resource.", "This a storage resource.", "This is a network resource." ], "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "RESOURCE_TYPE_COMPUTE", "RESOURCE_TYPE_STORAGE", "RESOURCE_TYPE_NETWORK" ] }, "resourceKind": { "description": "Required. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.", "type": "string", "enumDescriptions": [ "Unspecified resource kind.", "This is a compute instance.", "This is a compute disk.", "This is a compute address.", "This is a filestore instance.", "This is a compute health check.", "This is a compute forwarding rule.", "This is a compute backend service.", "This is a compute subnetwork.", "This is a compute network.", "This is a public accessible IP Address.", "This is a compute instance group." ], "enum": [ "RESOURCE_KIND_UNSPECIFIED", "RESOURCE_KIND_INSTANCE", "RESOURCE_KIND_DISK", "RESOURCE_KIND_ADDRESS", "RESOURCE_KIND_FILESTORE", "RESOURCE_KIND_HEALTH_CHECK", "RESOURCE_KIND_FORWARDING_RULE", "RESOURCE_KIND_BACKEND_SERVICE", "RESOURCE_KIND_SUBNETWORK", "RESOURCE_KIND_NETWORK", "RESOURCE_KIND_PUBLIC_ADDRESS", "RESOURCE_KIND_INSTANCE_GROUP" ] }, "resourceUri": { "description": "Required. URI of the resource, includes project, location, and name.", "type": "string" }, "relatedResources": { "description": "Optional. A list of resource URIs related to this resource.", "type": "array", "items": { "type": "string" } }, "updateTime": { "description": "Required. Unix timestamp of when this resource last had its discovery data updated.", "type": "string", "format": "google-datetime" }, "instanceProperties": { "description": "Optional. A set of properties only applying to instance type resources.", "$ref": "SapDiscoveryResourceInstanceProperties" } } }, "SapDiscoveryResourceInstanceProperties": { "id": "SapDiscoveryResourceInstanceProperties", "description": "A set of properties only present for an instance type resource", "type": "object", "properties": { "virtualHostname": { "description": "Optional. A virtual hostname of the instance if it has one.", "type": "string" }, "clusterInstances": { "description": "Optional. A list of instance URIs that are part of a cluster with this one.", "type": "array", "items": { "type": "string" } }, "instanceNumber": { "description": "Optional. The VM's instance number.", "deprecated": true, "type": "string", "format": "int64" }, "instanceRole": { "description": "Optional. Bitmask of instance role, a resource may have multiple roles at once.", "type": "string", "enumDescriptions": [ "Unspecified instance role.", "Application central services.", "Enqueue replication server.", "Application server.", "Database node.", "Combinations of roles. Application central services and enqueue replication server.", "Application central services and application server.", "Application central services and database.", "Enqueue replication server and application server.", "Enqueue replication server and database.", "Application server and database.", "Application central services, enqueue replication server and application server.", "Application central services, enqueue replication server and database.", "Application central services, application server and database.", "Enqueue replication server, application server and database.", "Application central services, enqueue replication server, application server and database." ], "enum": [ "INSTANCE_ROLE_UNSPECIFIED", "INSTANCE_ROLE_ASCS", "INSTANCE_ROLE_ERS", "INSTANCE_ROLE_APP_SERVER", "INSTANCE_ROLE_DATABASE", "INSTANCE_ROLE_ASCS_ERS", "INSTANCE_ROLE_ASCS_APP_SERVER", "INSTANCE_ROLE_ASCS_DATABASE", "INSTANCE_ROLE_ERS_APP_SERVER", "INSTANCE_ROLE_ERS_DATABASE", "INSTANCE_ROLE_APP_SERVER_DATABASE", "INSTANCE_ROLE_ASCS_ERS_APP_SERVER", "INSTANCE_ROLE_ASCS_ERS_DATABASE", "INSTANCE_ROLE_ASCS_APP_SERVER_DATABASE", "INSTANCE_ROLE_ERS_APP_SERVER_DATABASE", "INSTANCE_ROLE_ASCS_ERS_APP_SERVER_DATABASE" ] }, "appInstances": { "description": "Optional. App server instances on the host", "type": "array", "items": { "$ref": "SapDiscoveryResourceInstancePropertiesAppInstance" } }, "isDrSite": { "description": "Optional. Instance is part of a DR site.", "type": "boolean" }, "diskMounts": { "description": "Optional. Disk mounts on the instance.", "type": "array", "items": { "$ref": "SapDiscoveryResourceInstancePropertiesDiskMount" } }, "osKernelVersion": { "description": "Optional. The kernel version of the instance.", "$ref": "SapDiscoveryResourceInstancePropertiesKernelVersion" } } }, "SapDiscoveryResourceInstancePropertiesAppInstance": { "id": "SapDiscoveryResourceInstancePropertiesAppInstance", "description": "Fields to describe an SAP application server instance.", "type": "object", "properties": { "name": { "description": "Optional. Instance name of the SAP application instance.", "type": "string" }, "number": { "description": "Optional. Instance number of the SAP application instance.", "type": "string" } } }, "SapDiscoveryResourceInstancePropertiesDiskMount": { "id": "SapDiscoveryResourceInstancePropertiesDiskMount", "description": "Disk mount on the instance.", "type": "object", "properties": { "name": { "description": "Optional. Name of the disk.", "type": "string" }, "mountPoint": { "description": "Optional. Filesystem mount point.", "type": "string" }, "diskNames": { "description": "Optional. Names of the disks providing this mount point.", "type": "array", "items": { "type": "string" } } } }, "SapDiscoveryResourceInstancePropertiesKernelVersion": { "id": "SapDiscoveryResourceInstancePropertiesKernelVersion", "description": "KernelVersion encapsulates the kernel version data for the system.", "type": "object", "properties": { "rawString": { "description": "Optional. Raw string of the kernel version.", "type": "string" }, "osKernel": { "description": "Optional. Captures the OS-specific kernel version, the portion of the string up to the first dash.", "$ref": "SapDiscoveryResourceInstancePropertiesKernelVersionVersion" }, "distroKernel": { "description": "Optional. Captures the distro-specific kernel version, the portion of the string following the first dash.", "$ref": "SapDiscoveryResourceInstancePropertiesKernelVersionVersion" } } }, "SapDiscoveryResourceInstancePropertiesKernelVersionVersion": { "id": "SapDiscoveryResourceInstancePropertiesKernelVersionVersion", "description": "Version is reported as Major.Minor.Build.Patch.", "type": "object", "properties": { "major": { "description": "Optional. The major version number.", "type": "integer", "format": "int32" }, "minor": { "description": "Optional. The minor version number.", "type": "integer", "format": "int32" }, "build": { "description": "Optional. The build version number.", "type": "integer", "format": "int32" }, "patch": { "description": "Optional. The patch version number.", "type": "integer", "format": "int32" }, "remainder": { "description": "Optional. A catch-all for any unparsed version components. This is in case the number of points in the version string exceeds the expected count of 4.", "type": "string" } } }, "SapDiscoveryComponentApplicationProperties": { "id": "SapDiscoveryComponentApplicationProperties", "description": "A set of properties describing an SAP Application layer.", "type": "object", "properties": { "applicationType": { "description": "Required. Type of the application. Netweaver, etc.", "type": "string", "enumDescriptions": [ "Unspecified application type", "SAP Netweaver", "SAP Netweaver ABAP", "SAP Netweaver Java" ], "enum": [ "APPLICATION_TYPE_UNSPECIFIED", "NETWEAVER", "NETWEAVER_ABAP", "NETWEAVER_JAVA" ] }, "ascsUri": { "description": "Optional. Resource URI of the recognized ASCS host of the application.", "type": "string" }, "nfsUri": { "description": "Optional. Resource URI of the recognized shared NFS of the application. May be empty if the application server has only a single node.", "type": "string" }, "kernelVersion": { "description": "Optional. Kernel version for Netweaver running in the system.", "type": "string" }, "abap": { "description": "Optional. Deprecated: ApplicationType now tells you whether this is ABAP or Java.", "deprecated": true, "type": "boolean" }, "appInstanceNumber": { "description": "Optional. Instance number of the SAP application instance.", "type": "string" }, "ascsInstanceNumber": { "description": "Optional. Instance number of the ASCS instance.", "type": "string" }, "ersInstanceNumber": { "description": "Optional. Instance number of the ERS instance.", "type": "string" } } }, "SapDiscoveryComponentDatabaseProperties": { "id": "SapDiscoveryComponentDatabaseProperties", "description": "A set of properties describing an SAP Database layer.", "type": "object", "properties": { "databaseType": { "description": "Required. Type of the database. HANA, DB2, etc.", "type": "string", "enumDescriptions": [ "Unspecified database type.", "SAP HANA", "SAP MAX_DB", "IBM DB2", "Oracle Database", "Microsoft SQL Server", "SAP Sybase ASE" ], "enum": [ "DATABASE_TYPE_UNSPECIFIED", "HANA", "MAX_DB", "DB2", "ORACLE", "SQLSERVER", "ASE" ] }, "primaryInstanceUri": { "description": "Required. URI of the recognized primary instance of the database.", "type": "string" }, "sharedNfsUri": { "description": "Optional. URI of the recognized shared NFS of the database. May be empty if the database has only a single node.", "type": "string" }, "databaseVersion": { "description": "Optional. The version of the database software running in the system.", "type": "string" }, "instanceNumber": { "description": "Optional. Instance number of the SAP instance.", "type": "string" }, "databaseSid": { "description": "Optional. SID of the system database.", "type": "string" }, "landscapeId": { "description": "Optional. Landscape ID from the HANA nameserver.", "type": "string" } } }, "SapDiscoveryComponentReplicationSite": { "id": "SapDiscoveryComponentReplicationSite", "description": "A replication site used in Disaster Recovery (DR) configurations.", "type": "object", "properties": { "sourceSite": { "description": "Optional. The name of the source site from which this one replicates.", "type": "string" }, "component": { "description": "Optional. The system component for the site.", "$ref": "SapDiscoveryComponent" } } }, "SapDiscoveryWorkloadProperties": { "id": "SapDiscoveryWorkloadProperties", "description": "A set of properties describing an SAP workload.", "type": "object", "properties": { "productVersions": { "description": "Optional. List of SAP Products and their versions running on the system.", "type": "array", "items": { "$ref": "SapDiscoveryWorkloadPropertiesProductVersion" } }, "softwareComponentVersions": { "description": "Optional. A list of SAP software components and their versions running on the system.", "type": "array", "items": { "$ref": "SapDiscoveryWorkloadPropertiesSoftwareComponentProperties" } } } }, "SapDiscoveryWorkloadPropertiesProductVersion": { "id": "SapDiscoveryWorkloadPropertiesProductVersion", "description": "A product name and version.", "type": "object", "properties": { "name": { "description": "Optional. Name of the product.", "type": "string" }, "version": { "description": "Optional. Version of the product.", "type": "string" } } }, "SapDiscoveryWorkloadPropertiesSoftwareComponentProperties": { "id": "SapDiscoveryWorkloadPropertiesSoftwareComponentProperties", "description": "A SAP software component name, version, and type.", "type": "object", "properties": { "name": { "description": "Optional. Name of the component.", "type": "string" }, "version": { "description": "Optional. The component's major version.", "type": "string" }, "extVersion": { "description": "Optional. The component's minor version.", "type": "string" }, "type": { "description": "Optional. The component's type.", "type": "string" } } }, "SqlserverValidation": { "id": "SqlserverValidation", "description": "A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data.", "type": "object", "properties": { "agentVersion": { "description": "Optional. The agent version collected this data point", "type": "string" }, "validationDetails": { "description": "Optional. A list of SqlServer validation metrics data.", "type": "array", "items": { "$ref": "SqlserverValidationValidationDetail" } }, "projectId": { "description": "Required. The project_id of the cloud project that the Insight data comes from.", "type": "string" }, "instance": { "description": "Required. The instance_name of the instance that the Insight data comes from. According to https://linter.aip.dev/122/name-suffix: field names should not use the _name suffix unless the field would be ambiguous without it.", "type": "string" } } }, "SqlserverValidationValidationDetail": { "id": "SqlserverValidationValidationDetail", "description": "Message describing the Sqlserver validation metrics.", "type": "object", "properties": { "type": { "description": "Optional. The Sqlserver system that the validation data is from.", "type": "string", "enumDescriptions": [ "Unspecified type.", "The Sqlserver system named OS.", "The LOG_DISK_SEPARATION table.", "The MAX_PARALLELISM table.", "The CXPACKET_WAITS table.", "The TRANSACTION_LOG_HANDLING table.", "The VIRTUAL_LOG_FILE_COUNT table.", "The BUFFER_POOL_EXTENSION table.", "The MAX_SERVER_MEMORY table.", "The INSTANCE_METRICS table.", "The DB_INDEX_FRAGMENTATION table.", "The DB_TABLE_INDEX_COMPRESSION table.", "The DB_BACKUP_POLICY table." ], "enum": [ "SQLSERVER_VALIDATION_TYPE_UNSPECIFIED", "OS", "DB_LOG_DISK_SEPARATION", "DB_MAX_PARALLELISM", "DB_CXPACKET_WAITS", "DB_TRANSACTION_LOG_HANDLING", "DB_VIRTUAL_LOG_FILE_COUNT", "DB_BUFFER_POOL_EXTENSION", "DB_MAX_SERVER_MEMORY", "INSTANCE_METRICS", "DB_INDEX_FRAGMENTATION", "DB_TABLE_INDEX_COMPRESSION", "DB_BACKUP_POLICY" ] }, "details": { "description": "Required. Details wraps map that represents collected data names and values.", "type": "array", "items": { "$ref": "SqlserverValidationDetails" } } } }, "SqlserverValidationDetails": { "id": "SqlserverValidationDetails", "description": "Message containing collected data names and values.", "type": "object", "properties": { "fields": { "description": "Required. Collected data is in format.", "type": "object", "additionalProperties": { "type": "string" } } } }, "TorsoValidation": { "id": "TorsoValidation", "description": "The schema of torso workload validation data.", "type": "object", "properties": { "workloadType": { "description": "Required. workload_type specifies the type of torso workload.", "type": "string", "enumDescriptions": [ "Unspecified workload type.", "MySQL workload.", "Oracle workload.", "Redis workload." ], "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "MYSQL", "ORACLE", "REDIS" ] }, "validationDetails": { "description": "Required. validation_details contains the pairs of validation data: field name & field value.", "type": "object", "additionalProperties": { "type": "string" } }, "agentVersion": { "description": "Required. agent_version lists the version of the agent that collected this data.", "type": "string" }, "projectId": { "description": "Required. project_id lists the human readable cloud project that the data comes from.", "type": "string" }, "instanceName": { "description": "Optional. instance_name lists the human readable name of the instance that the data comes from.", "type": "string" } } }, "AgentStatus": { "id": "AgentStatus", "description": "The schema of agent status data.", "type": "object", "properties": { "installedVersion": { "description": "Output only. The installed version of the agent on the host.", "readOnly": true, "type": "string" }, "availableVersion": { "description": "Output only. The available version of the agent in artifact registry.", "readOnly": true, "type": "string" }, "systemdServiceEnabled": { "description": "Output only. Whether the agent service is enabled in systemd.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified and has not been checked yet.", "The state is successful (enabled, granted, fully functional).", "The state is failed (disabled, denied, not fully functional).", "There was an internal error while checking the state, state is unknown." ], "enum": [ "UNSPECIFIED_STATE", "SUCCESS_STATE", "FAILURE_STATE", "ERROR_STATE" ] }, "systemdServiceRunning": { "description": "Output only. Whether the agent service is running in systemd.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified and has not been checked yet.", "The state is successful (enabled, granted, fully functional).", "The state is failed (disabled, denied, not fully functional).", "There was an internal error while checking the state, state is unknown." ], "enum": [ "UNSPECIFIED_STATE", "SUCCESS_STATE", "FAILURE_STATE", "ERROR_STATE" ] }, "configurationFilePath": { "description": "Output only. The path to the agent configuration file.", "readOnly": true, "type": "string" }, "configurationValid": { "description": "Output only. Whether the agent configuration is valid.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified and has not been checked yet.", "The state is successful (enabled, granted, fully functional).", "The state is failed (disabled, denied, not fully functional).", "There was an internal error while checking the state, state is unknown." ], "enum": [ "UNSPECIFIED_STATE", "SUCCESS_STATE", "FAILURE_STATE", "ERROR_STATE" ] }, "configurationErrorMessage": { "description": "Output only. The error message for the agent configuration if invalid.", "readOnly": true, "type": "string" }, "services": { "description": "Output only. The services (process metrics, host metrics, etc.).", "readOnly": true, "type": "array", "items": { "$ref": "AgentStatusServiceStatus" } }, "references": { "description": "Output only. Optional references to public documentation.", "readOnly": true, "type": "array", "items": { "$ref": "AgentStatusReference" } }, "agentName": { "description": "Output only. The name of the agent.", "readOnly": true, "type": "string" }, "cloudApiAccessFullScopesGranted": { "description": "Output only. Whether the agent has full access to Cloud APIs.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified and has not been checked yet.", "The state is successful (enabled, granted, fully functional).", "The state is failed (disabled, denied, not fully functional).", "There was an internal error while checking the state, state is unknown." ], "enum": [ "UNSPECIFIED_STATE", "SUCCESS_STATE", "FAILURE_STATE", "ERROR_STATE" ] }, "kernelVersion": { "description": "Output only. The kernel version of the system.", "readOnly": true, "$ref": "SapDiscoveryResourceInstancePropertiesKernelVersion" }, "instanceUri": { "description": "Output only. The URI of the instance. Format: projects//zones//instances/", "readOnly": true, "type": "string" } } }, "AgentStatusServiceStatus": { "id": "AgentStatusServiceStatus", "description": "The status of a service (process metrics, host metrics, etc.).", "type": "object", "properties": { "name": { "description": "Output only. The name of the service.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The state of the service (enabled or disabled in the configuration).", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified and has not been checked yet.", "The state is successful (enabled, granted, fully functional).", "The state is failed (disabled, denied, not fully functional).", "There was an internal error while checking the state, state is unknown." ], "enum": [ "UNSPECIFIED_STATE", "SUCCESS_STATE", "FAILURE_STATE", "ERROR_STATE" ] }, "fullyFunctional": { "description": "Output only. Whether the service is fully functional (all checks passed).", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified and has not been checked yet.", "The state is successful (enabled, granted, fully functional).", "The state is failed (disabled, denied, not fully functional).", "There was an internal error while checking the state, state is unknown." ], "enum": [ "UNSPECIFIED_STATE", "SUCCESS_STATE", "FAILURE_STATE", "ERROR_STATE" ] }, "errorMessage": { "description": "Output only. The error message for the service if it is not fully functional.", "readOnly": true, "type": "string" }, "iamPermissions": { "description": "Output only. The permissions required for the service.", "readOnly": true, "type": "array", "items": { "$ref": "AgentStatusIAMPermission" } }, "configValues": { "description": "Output only. The configuration values for the service.", "readOnly": true, "type": "array", "items": { "$ref": "AgentStatusConfigValue" } }, "unspecifiedStateMessage": { "description": "Output only. The message to display when the service state is unspecified.", "readOnly": true, "type": "string" } } }, "AgentStatusIAMPermission": { "id": "AgentStatusIAMPermission", "description": "The IAM permission status.", "type": "object", "properties": { "name": { "description": "Output only. The name of the permission.", "readOnly": true, "type": "string" }, "granted": { "description": "Output only. Whether the permission is granted.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified and has not been checked yet.", "The state is successful (enabled, granted, fully functional).", "The state is failed (disabled, denied, not fully functional).", "There was an internal error while checking the state, state is unknown." ], "enum": [ "UNSPECIFIED_STATE", "SUCCESS_STATE", "FAILURE_STATE", "ERROR_STATE" ] } } }, "AgentStatusConfigValue": { "id": "AgentStatusConfigValue", "description": "The configuration value.", "type": "object", "properties": { "name": { "description": "Output only. The name of the configuration value.", "readOnly": true, "type": "string" }, "value": { "description": "Output only. The value of the configuration value.", "readOnly": true, "type": "string" }, "isDefault": { "description": "Output only. Whether the configuration value is the default value or overridden.", "readOnly": true, "type": "boolean" } } }, "AgentStatusReference": { "id": "AgentStatusReference", "description": "The reference to public documentation.", "type": "object", "properties": { "name": { "description": "Output only. The name of the reference.", "readOnly": true, "type": "string" }, "url": { "description": "Output only. The URL of the reference.", "readOnly": true, "type": "string" } } }, "OpenShiftValidation": { "id": "OpenShiftValidation", "description": "A presentation of OpenShift workload insight. The schema of OpenShift workloads validation related data.", "type": "object", "properties": { "clusterId": { "description": "Required. The OpenShift cluster ID (e.g. 8371bb05-7cac-4d38-82c0-0f58c4f6f936).", "type": "string" }, "validationDetails": { "description": "Required. The validation details of the OpenShift cluster in JSON format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "WriteInsightResponse": { "id": "WriteInsightResponse", "description": "The response for write insights request.", "type": "object", "properties": {} }, "ListDeploymentsResponse": { "id": "ListDeploymentsResponse", "description": "Message for response to listing deployments.", "type": "object", "properties": { "deployments": { "description": "The list of deployments.", "type": "array", "items": { "$ref": "Deployment" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Deployment": { "id": "Deployment", "description": "The Deployment object represents user intent for deploying a specific type of workload.", "type": "object", "properties": { "name": { "description": "The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.", "type": "string" }, "description": { "description": "Description of the deployment.", "type": "string" }, "workloadType": { "description": "Optional. Workload type of the deployment.", "type": "string", "enumDescriptions": [ "Unspecified workload type.", "SAP S/4HANA workload type.", "SQL Server workload type.", "Oracle workload type." ], "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "SAP_S4", "SQL_SERVER", "ORACLE" ] }, "terraformVariables": { "description": "Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { \"project_id\": { \"input_value\": { \"string_value\": \"my-project-id\" } }, \"zone\": { \"input_value\": { \"string_value\": \"us-central1-a\" } } }", "type": "object", "additionalProperties": { "$ref": "TerraformVariable" } }, "sapSystemS4Config": { "description": "SAP system workload input.", "$ref": "SapSystemS4Config" }, "sqlServerWorkload": { "description": "MS SQL workload input.", "$ref": "SqlServerWorkload" }, "createTime": { "description": "Output only. Create time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Update time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. Current state of the deployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The deployment is being created.", "The deployment is healthy.", "The deployment is being updated.", "The deployment is being deleted.", "The deployment has encountered an unexpected error." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED" ] }, "serviceAccount": { "description": "User-specified Service Account (SA) credentials to be used for Cloud Build. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation.", "type": "string" }, "workerPool": { "description": "Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.", "type": "string" } } }, "TerraformVariable": { "id": "TerraformVariable", "description": "In order to align with the Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest. A Terraform input variable.", "type": "object", "properties": { "inputValue": { "description": "Optional. Input variable value.", "type": "any" } } }, "SapSystemS4Config": { "id": "SapSystemS4Config", "description": "Message for SAP system workload.", "type": "object", "properties": { "gcpProjectId": { "description": "The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.", "type": "string" }, "location": { "description": "Database details.", "$ref": "LocationDetails" }, "database": { "description": "Database details.", "$ref": "DatabaseDetails" }, "app": { "description": "Instance details.", "$ref": "AppDetails" }, "allowStoppingForUpdate": { "type": "boolean" }, "version": { "description": "Required. SAP HANA version.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "VERSION_UNSPECIFIED", "S4_HANA_2021", "S4_HANA_2022", "S4_HANA_2023" ] }, "environmentType": { "description": "Required. Deployment environment.", "type": "string", "enumDescriptions": [ "Unspecified environment type.", "Non-production environment type.", "Production environment type." ], "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "NON_PRODUCTION", "PRODUCTION" ] }, "deploymentModel": { "description": "Required. Supports non-HA and HA models.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "DEPLOYMENT_MODEL_UNSPECIFIED", "DISTRIBUTED", "DISTRIBUTED_HA" ] }, "scalingMethod": { "description": "Required. Supports scale up and scale out.", "type": "string", "enumDescriptions": [ "", "Scale up: Increases the size of a physical machine by increasing the amount of RAM and CPU available for processing.", "Scale out: Combines multiple independent computers into one system." ], "enum": [ "SCALE_METHOD_UNSPECIFIED", "SCALE_UP", "SCALE_OUT" ] }, "mediaBucketName": { "description": "Required. Media bucket name.", "type": "string" }, "sapBootDiskImage": { "description": "Optional. SAP boot disk image.", "type": "string" }, "vmPrefix": { "description": "VM prefix.", "type": "string" }, "ansibleRunnerServiceAccount": { "description": "Ansible runner service account. Let customers bring their own service account for the Ansible runner.", "type": "string" } } }, "LocationDetails": { "id": "LocationDetails", "description": "Message for SAP instance details.", "type": "object", "properties": { "vpcName": { "description": "Required. VPC name.", "type": "string" }, "zone1Name": { "description": "Required. Zone 1 name.", "type": "string" }, "zone2Name": { "description": "Optional. Zone 2 name.", "type": "string" }, "dnsZoneNameSuffix": { "description": "Optional. DNS zone name suffix.", "type": "string" }, "regionName": { "description": "Required. Region name.", "type": "string" }, "internetAccess": { "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "INTERNETACCESS_UNSPECIFIED", "ALLOW_EXTERNAL_IP", "CONFIGURE_NAT" ] }, "subnetName": { "description": "Required. Subnet name.", "type": "string" }, "dnsZone": { "description": "Optional. DNS zone name.", "type": "string" }, "networkProject": { "description": "Optional. Network project.", "type": "string" }, "createCommsFirewall": { "description": "Optional. Create firewall. If true, creates a firewall for the deployment. This field provides an option to not always create a firewall for the deployment.", "type": "boolean" }, "deploymentDnsEnabled": { "description": "Optional. When the user skips DNS configuration in the UI, `deployment_dns_enabled` is false; otherwise `deployment_dns_enabled` is true.", "type": "boolean" }, "customTags": { "description": "Optional. Network tags.", "type": "array", "items": { "type": "string" } } } }, "DatabaseDetails": { "id": "DatabaseDetails", "description": "Message for SAP instance details.", "type": "object", "properties": { "sid": { "description": "Required. The SID is a three-digit server-specific unique identification code.", "type": "string" }, "machineType": { "description": "Required. Machine type.", "type": "string" }, "diskType": { "description": "Required. Disk type.", "type": "string" }, "secretManagerSecret": { "description": "Required. Secret Manager secret.", "type": "string" }, "image": { "description": "Required. Image for the database server.", "type": "string" }, "instanceId": { "description": "Optional. Instance ID.", "type": "string" }, "primaryDbVm": { "description": "Optional. Primary DB VM name.", "type": "string" }, "secondaryDbVm": { "description": "Optional. Secondary DB VM name.", "type": "string" }, "databaseServiceAccount": { "description": "Database service account. Let customers bring their own SA for the database.", "type": "string" } } }, "AppDetails": { "id": "AppDetails", "description": "Message for SAP instance details.", "type": "object", "properties": { "sid": { "description": "Required. The SAP SID is a three-digit server-specific unique identification code.", "type": "string" }, "vmsMultiplier": { "description": "Required. VMs multiplier.", "type": "integer", "format": "int32" }, "machineType": { "description": "Required. Machine type.", "type": "string" }, "ascsMachineType": { "description": "Required. ASCS machine type.", "type": "string" }, "secretManagerSecret": { "description": "Required. Secret Manager secret.", "type": "string" }, "image": { "description": "Required. Image for the app server and ASCS server.", "type": "string" }, "ascsInstanceId": { "description": "Optional. Instance ID for ASCS.", "type": "string" }, "ersInstanceId": { "description": "Optional. Instance ID for ERS.", "type": "string" }, "appInstanceId": { "description": "Optional. Instance ID for app.", "type": "string" }, "ascsVm": { "description": "Optional. ASCS VM name.", "type": "string" }, "ersVm": { "description": "Optional. ERS VM name.", "type": "string" }, "ascsImage": { "description": "Required. Image for the ASCS server.", "type": "string" }, "ascsServiceAccount": { "description": "ASCS service account. Let customers bring their own service account for ASCS.", "type": "string" }, "appServiceAccount": { "description": "Application service account. Let customers bring their own service account for the application.", "type": "string" }, "appVmNames": { "description": "Optional. Customized VM names.", "type": "array", "items": { "type": "string" } }, "sharedStorage": { "description": "Optional. Storage location.", "type": "string" } } }, "SqlServerWorkload": { "id": "SqlServerWorkload", "description": "Message for MS SQL workload.", "type": "object", "properties": { "environmentType": { "description": "Required. Deployment environment.", "type": "string", "enumDescriptions": [ "Unspecified environment type.", "Non-production environment type.", "Production environment type." ], "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "NON_PRODUCTION", "PRODUCTION" ] }, "operatingSystemType": { "description": "Required. The type of the operating system the SQL server is going to run on top of.", "type": "string", "enumDescriptions": [ "Unspecified operating system type.", "Windows operating system type.", "Ubuntu operating system type.", "Red Hat Enterprise Linux operating system type.", "SUSE operating system type." ], "enum": [ "OPERATING_SYSTEM_TYPE_UNSPECIFIED", "WINDOWS", "UBUNTU", "RED_HAT_ENTERPRISE_LINUX", "SUSE" ] }, "osImage": { "description": "Required. The image of the operating system.", "type": "string" }, "deploymentModel": { "description": "Required. HIGH_AVAILABILITY or SINGLE_INSTANCE.", "type": "string", "enumDescriptions": [ "Unspecified deployment model.", "High Availability deployment model.", "Single instance deployment model." ], "enum": [ "DEPLOYMENT_MODEL_UNSPECIFIED", "HIGH_AVAILABILITY", "SINGLE_INSTANCE" ] }, "haType": { "description": "Optional. AOAG or FCI. It is only needed for the High Availability deployment mode.", "type": "string", "enumDescriptions": [ "Unspecified HA type.", "AOAG HA type.", "FCI HA type." ], "enum": [ "HA_TYPE_UNSPECIFIED", "AOAG", "FCI" ] }, "vmPrefix": { "description": "Required. Should be unique in the project.", "type": "string" }, "mediaBucket": { "description": "Required. Name of the media storing SQL server installation files.", "type": "string" }, "location": { "description": "Required. Location details.", "$ref": "SqlLocationDetails" }, "activeDirectory": { "description": "Required. Active Directory details.", "$ref": "ActiveDirectory" }, "database": { "description": "Required. Database details.", "$ref": "Database" }, "pacemaker": { "description": "Optional. Pacemaker configuration, only applicable for Linux HA deployments.", "$ref": "Pacemaker" }, "fciType": { "description": "Optional. SHARED_DISK or S2D.", "type": "string", "enumDescriptions": [ "Unspecified FCI type.", "SHARED DISK FCI type.", "S2D FCI type." ], "enum": [ "FCI_TYPE_UNSPECIFIED", "SHARED_DISK", "S2D" ] }, "isSqlPayg": { "description": "Required. SQL licensing type.", "type": "boolean" }, "sqlServerEdition": { "description": "Optional. SQL Server Edition type, only applicable when the operating system is Linux.", "type": "string", "enumDescriptions": [ "Unspecified type.", "Developer type.", "Enterprise type.", "Standard type.", "Web type." ], "enum": [ "SQL_SERVER_EDITION_TYPE_UNSPECIFIED", "SQL_SERVER_EDITION_TYPE_DEVELOPER", "SQL_SERVER_EDITION_TYPE_ENTERPRISE", "SQL_SERVER_EDITION_TYPE_STANDARD", "SQL_SERVER_EDITION_TYPE_WEB" ] }, "sqlServerVersion": { "description": "Optional. 2017, 2019, or 2022.", "type": "string", "enumDescriptions": [ "Unspecified type.", "2017 type.", "2019 type.", "2022 type." ], "enum": [ "SQL_SERVER_VERSION_TYPE_UNSPECIFIED", "SQL_SERVER_VERSION_TYPE_2017", "SQL_SERVER_VERSION_TYPE_2019", "SQL_SERVER_VERSION_TYPE_2022" ] }, "osImageType": { "description": "Optional. OS image type. It's used to create boot disks for VM instances. When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and defaults to a custom image.", "type": "string", "enumDescriptions": [ "Unspecified OS image type.", "Public image.", "Custom image." ], "enum": [ "OS_IMAGE_TYPE_UNSPECIFIED", "PUBLIC_IMAGE", "CUSTOM_IMAGE" ] }, "computeEngineServiceAccount": { "description": "Compute Engine service account. Let customers bring their own service account for Compute Engine.", "type": "string" } } }, "SqlLocationDetails": { "id": "SqlLocationDetails", "description": "Location and networking details for configuring SQL server workload.", "type": "object", "properties": { "gcpProjectId": { "description": "Required. The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.", "type": "string" }, "region": { "description": "Required. Region name.", "type": "string" }, "primaryZone": { "description": "Required. Primary zone.", "type": "string" }, "secondaryZone": { "description": "Optional. Secondary zone cannot be the same as primary_zone and is only for High Availability deployment mode.", "type": "string" }, "network": { "description": "Required. Network name.", "type": "string" }, "subnetwork": { "description": "Required. Subnetwork name.", "type": "string" }, "internetAccess": { "description": "Required. Internet Access.", "type": "string", "enumDescriptions": [ "Unspecified internet access.", "Allow external IP.", "Configure NAT." ], "enum": [ "INTERNET_ACCESS_UNSPECIFIED", "ALLOW_EXTERNAL_IP", "CONFIGURE_NAT" ] }, "dnsZone": { "description": "Optional. Create a new DNS zone when the field is empty. Only shown for `Using an existing DNS`. List of existing DNS zones. Terraform variable name: existing_dns_zone_name.", "type": "string" }, "tertiaryZone": { "description": "Optional. Tertiary zone cannot be the same as primary_zone and secondary_zone, and it is only for High Availability deployment mode.", "type": "string" } } }, "ActiveDirectory": { "id": "ActiveDirectory", "description": "Active Directory details.", "type": "object", "properties": { "type": { "description": "Required. Active Directory type.", "type": "string", "enumDescriptions": [ "Unspecified Active Directory type.", "GCP managed Active Directory type.", "Self managed Active Directory type." ], "enum": [ "ACTIVE_DIRECTORY_TYPE_UNSPECIFIED", "GCP_MANAGED", "SELF_MANAGED" ] }, "domainUsername": { "description": "Optional. Domain username.", "type": "string" }, "secretManagerSecret": { "description": "Required. Secret Manager secret.", "type": "string" }, "dnsAddress": { "description": "Optional. DNS IP address.", "type": "string" }, "domain": { "description": "Optional. Human readable form of a domain such as “google.com”.", "type": "string" } } }, "Database": { "id": "Database", "description": "Database details.", "type": "object", "properties": { "secretManagerSecret": { "description": "Required. Secret Manager secret.", "type": "string" }, "floatingIpAddress": { "description": "Optional. Only useful for Linux High Availability setup.", "type": "string" }, "machineType": { "description": "Required. Machine type.", "type": "string" }, "smt": { "description": "Required. Whether simultaneous multithreading is enabled or not.", "type": "boolean" }, "tempdbOnSsd": { "description": "Required. Whether to have TempDB on local SSD.", "type": "boolean" }, "tenancyModel": { "description": "Required. SHARED or SOLE_TENANT.", "type": "string", "enumDescriptions": [ "Unspecified tenancy model.", "Shared tenancy model.", "Sole Tenant tenancy model." ], "enum": [ "TENANCY_MODEL_UNSPECIFIED", "SHARED", "SOLE_TENANT" ] }, "soleTenantNode": { "description": "Optional. The name of a primary sole-tenant node/node group.", "type": "string" }, "soleTenantNodeType": { "description": "Optional. The type of a primary sole-tenant node/node group. E.g., compute.googleapis.com/node-name.", "type": "string" }, "secondarySoleTenantNode": { "description": "Optional. The name of a secondary-sole-tenant node/node group.", "type": "string" }, "secondarySoleTenantNodeType": { "description": "Optional. The type of a secondary-sole-tenant node/node group. E.g., compute.googleapis.com/node-name.", "type": "string" }, "diskType": { "description": "Required. Disk type.", "type": "string" } } }, "Pacemaker": { "id": "Pacemaker", "description": "Pacemaker configuration.", "type": "object", "properties": { "pacemakerCluster": { "description": "Required. Pacemaker cluster name.", "type": "string" }, "pacemakerClusterUsername": { "description": "Required. Pacemaker cluster username.", "type": "string" }, "pacemakerClusterSecret": { "description": "Required. Pacemaker cluster secret name.", "type": "string" }, "sqlPacemakerUsername": { "description": "Required. SQL Pacemaker username.", "type": "string" }, "sqlPacemakerSecret": { "description": "Required. SQL Pacemaker secret name.", "type": "string" }, "bucketNameNodeCertificates": { "description": "Required. Bucket location for node certificates.", "type": "string" } } }, "ListActuationsResponse": { "id": "ListActuationsResponse", "description": "The response object from `ListActuations`.", "type": "object", "properties": { "actuations": { "description": "The list of actuations.", "type": "array", "items": { "$ref": "Actuation" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Actuation": { "id": "Actuation", "description": "The Actuation object represents the bootstrap state and output results of deployed infrastructure and software.", "type": "object", "properties": { "name": { "description": "The name of the actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}.", "type": "string" }, "actuationOutput": { "description": "Output only. Actuation output.", "readOnly": true, "$ref": "ActuationOutput" }, "state": { "description": "Output only. Actuation state.", "readOnly": true, "type": "string", "enumDescriptions": [ "State unspecified.", "Creating infrastructure in backend (Terraform applying).", "Success.", "Failed either in infra creating, post infra configuring, or infra destroying.", "Configure workload after infrastructure is ready (Ansible running).", "Destroying infrastructure in backend (Terraform destroying).", "Ansible timed out due to losing heartbeat in post infra configuring." ], "enum": [ "STATE_UNSPECIFIED", "INFRA_CREATING", "SUCCEEDED", "FAILED", "POST_INFRA_CONFIGURING", "INFRA_DESTROYING", "TIMEOUT" ] }, "deploymentOutput": { "description": "Output only. Deployment output.", "readOnly": true, "type": "array", "items": { "$ref": "DeploymentOutput" } }, "startTime": { "description": "Output only. Start time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. End time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ActuationOutput": { "id": "ActuationOutput", "description": "Message for output of actuation.", "type": "object", "properties": { "blueprintId": { "description": "Reference to the Blueprint Controller deployment and revision resource.", "type": "string" }, "terraformTemplate": { "description": "Reference to the Terraform template used.", "type": "string" }, "errorLogs": { "description": "A link to the actuation Cloud Build log.", "type": "string" }, "actuateLogs": { "description": "A link to the Cloud Storage file that stores build logs.", "type": "string" }, "errorCode": { "description": "Output only. Code describing any errors that may have occurred. If not specified, there is no error in actuation.", "readOnly": true, "type": "string", "enumDescriptions": [ "No error code was specified.", "General Terraform failure.", "Permission error in Terraform.", "Quota related error in Terraform.", "General Ansible failure.", "Constraint related error in Terraform.", "Resource already exists error in Terraform.", "Resource not found error in Terraform.", "Permission denied error in Ansible.", "Secret related error in Ansible.", "General Terraform failure during deletion.", "Resource in use error in Terraform deletion.", "Startup failure in Ansible." ], "enum": [ "ERROR_CODE_UNSPECIFIED", "TERRAFORM_FAILED", "PERMISSION_DENIED_IN_TERRAFORM", "QUOTA_EXCEED_IN_TERRAFORM", "ANSIBLE_FAILED", "CONSTRAINT_VIOLATION_IN_TERRAFORM", "RESOURCE_ALREADY_EXISTS_IN_TERRAFORM", "RESOURCE_UNAVAILABLE_IN_TERRAFORM", "PERMISSION_DENIED_IN_ANSIBLE", "INVALID_SECRET_IN_ANSIBLE", "TERRAFORM_DELETION_FAILED", "RESOURCE_IN_USE_IN_TERRAFORM_DELETION", "ANSIBLE_START_FAILED" ] }, "ansibleError": { "description": "Output only. Error message returned from Ansible.", "readOnly": true, "type": "string" }, "cloudbuildId": { "description": "Cloud Build instance UUID associated with this revision, without any suffix or prefix", "type": "string" }, "ansibleFailedTask": { "description": "Output only. Failed task name returned from Ansible.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "terraformError": { "description": "Output only. Error message returned from Terraform.", "readOnly": true, "type": "string" }, "hasUserFacingErrorMsg": { "description": "Output only. Whether the error message is user facing. If true, the error message will be shown in the UI.", "readOnly": true, "type": "boolean" } } }, "DeploymentOutput": { "id": "DeploymentOutput", "description": "Message for output of deployment resource.", "type": "object", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "type": { "description": "Type of the resource.", "type": "string" } } }, "ListDiscoveredProfilesResponse": { "id": "ListDiscoveredProfilesResponse", "description": "List discovered profile Response returns discovered profiles from agents", "type": "object", "properties": { "workloadProfiles": { "description": "Output only. The list of workload profiles", "readOnly": true, "type": "array", "items": { "$ref": "WorkloadProfile" } }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "Output only. A token identifying a page of results the server should return", "readOnly": true, "type": "string" } } }, "WorkloadProfile": { "id": "WorkloadProfile", "description": "Workload resource.", "type": "object", "properties": { "name": { "description": "Identifier. name of resource names have the form 'projects/{project_id}/locations/{location}/workloadProfiles/{workload_id}'", "type": "string" }, "labels": { "description": "Optional. such as name, description, version. More example can be found in deployment", "type": "object", "additionalProperties": { "type": "string" } }, "refreshedTime": { "description": "Required. time when the workload data was refreshed", "type": "string", "format": "google-datetime" }, "workloadType": { "description": "Required. The type of the workload", "type": "string", "enumDescriptions": [ "unspecified workload type", "running sap workload s4/hana" ], "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "S4_HANA" ] }, "sapWorkload": { "description": "The sap workload content", "$ref": "SapWorkload" } } }, "SapWorkload": { "id": "SapWorkload", "description": "The body of sap workload", "type": "object", "properties": { "metadata": { "description": "Output only. The metadata for SAP workload.", "readOnly": true, "type": "object", "additionalProperties": { "type": "string" } }, "database": { "description": "Output only. database component", "readOnly": true, "$ref": "SapComponent" }, "application": { "description": "Output only. application component", "readOnly": true, "$ref": "SapComponent" }, "products": { "description": "Output only. The products on this workload.", "readOnly": true, "type": "array", "items": { "$ref": "Product" } }, "architecture": { "description": "Output only. The architecture.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified architecture.", "Invaliad architecture.", "A centralized system.", "A distributed system.", "A distributed with HA system.", "A standalone database system.", "A standalone database with HA system." ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "INVALID", "CENTRALIZED", "DISTRIBUTED", "DISTRIBUTED_HA", "STANDALONE_DATABASE", "STANDALONE_DATABASE_HA" ] } } }, "SapComponent": { "id": "SapComponent", "description": "The component of sap workload", "type": "object", "properties": { "sid": { "description": "Output only. sid is the sap component identificator", "readOnly": true, "type": "string" }, "resources": { "description": "Output only. resources in the component", "readOnly": true, "type": "array", "items": { "$ref": "CloudResource" } }, "topologyType": { "description": "The detected topology of the component.", "type": "string", "enumDescriptions": [ "Unspecified topology.", "A scale-up single node system.", "A scale-out multi-node system." ], "enum": [ "TOPOLOGY_TYPE_UNSPECIFIED", "TOPOLOGY_SCALE_UP", "TOPOLOGY_SCALE_OUT" ] }, "haHosts": { "description": "List of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.", "type": "array", "items": { "type": "string" } }, "databaseProperties": { "description": "Output only. All instance properties.", "readOnly": true, "$ref": "DatabaseProperties" } } }, "CloudResource": { "id": "CloudResource", "description": "The resource on GCP", "type": "object", "properties": { "name": { "description": "Output only. resource name Example: compute.googleapis.com/projects/wlm-obs-dev/zones/us-central1-a/instances/sap-pri", "readOnly": true, "type": "string" }, "kind": { "description": "Output only. ", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified resource kind.", "This is a compute instance.", "This is a compute disk.", "This is a compute address.", "This is a filestore instance.", "This is a compute health check.", "This is a compute forwarding rule.", "This is a compute backend service.", "This is a compute subnetwork.", "This is a compute network.", "This is a public accessible IP Address.", "This is a compute instance group." ], "enum": [ "RESOURCE_KIND_UNSPECIFIED", "RESOURCE_KIND_INSTANCE", "RESOURCE_KIND_DISK", "RESOURCE_KIND_ADDRESS", "RESOURCE_KIND_FILESTORE", "RESOURCE_KIND_HEALTH_CHECK", "RESOURCE_KIND_FORWARDING_RULE", "RESOURCE_KIND_BACKEND_SERVICE", "RESOURCE_KIND_SUBNETWORK", "RESOURCE_KIND_NETWORK", "RESOURCE_KIND_PUBLIC_ADDRESS", "RESOURCE_KIND_INSTANCE_GROUP" ] }, "instanceProperties": { "description": "Output only. All instance properties.", "readOnly": true, "$ref": "InstanceProperties" } } }, "InstanceProperties": { "id": "InstanceProperties", "description": "Instance Properties.", "type": "object", "properties": { "status": { "description": "Optional. Instance status.", "type": "string" }, "machineType": { "description": "Optional. Instance machine type.", "type": "string" }, "instanceNumber": { "description": "Optional. Instance number.", "type": "string" }, "upcomingMaintenanceEvent": { "description": "Optional. the next maintenance event on VM", "$ref": "UpcomingMaintenanceEvent" }, "sapInstanceProperties": { "description": "Optional. SAP Instance properties.", "$ref": "SapInstanceProperties" }, "roles": { "description": "Optional. Instance roles.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Unspecified role.", "ASCS role.", "ERS role.", "APP server.", "HANA primary role.", "HANA secondary role." ], "enum": [ "INSTANCE_ROLE_UNSPECIFIED", "INSTANCE_ROLE_ASCS", "INSTANCE_ROLE_ERS", "INSTANCE_ROLE_APP_SERVER", "INSTANCE_ROLE_HANA_PRIMARY", "INSTANCE_ROLE_HANA_SECONDARY" ] } } } }, "UpcomingMaintenanceEvent": { "id": "UpcomingMaintenanceEvent", "description": "Maintenance Event", "type": "object", "properties": { "startTime": { "description": "Optional. Start time", "type": "string", "format": "google-datetime" }, "endTime": { "description": "Optional. End time", "type": "string", "format": "google-datetime" }, "maintenanceStatus": { "description": "Optional. Maintenance status", "type": "string" }, "type": { "description": "Optional. Type", "type": "string" }, "onHostMaintenance": { "description": "Optional. Instance maintenance behavior. Could be `MIGRATE` or `TERMINATE`.", "type": "string" } } }, "SapInstanceProperties": { "id": "SapInstanceProperties", "description": "SAP instance properties.", "type": "object", "properties": { "numbers": { "description": "Optional. SAP Instance numbers. They are from '00' to '99'.", "type": "array", "items": { "type": "string" } }, "agentStates": { "description": "Optional. Sap Instance Agent status.", "$ref": "AgentStates" } } }, "AgentStates": { "id": "AgentStates", "description": "Agent status.", "type": "object", "properties": { "installedVersion": { "description": "Optional. The installed version of the agent on the host.", "type": "string" }, "availableVersion": { "description": "Optional. The available version of the agent in artifact registry.", "type": "string" }, "isFullyEnabled": { "description": "Optional. Whether the agent is fully enabled. If false, the agent is has some issues.", "type": "boolean" }, "processMetrics": { "description": "Optional. The Process metrics of the agent.", "$ref": "ServiceStates" }, "systemDiscovery": { "description": "Optional. The System discovery metrics of the agent.", "$ref": "ServiceStates" }, "hanaMonitoring": { "description": "Optional. HANA monitoring metrics of the agent.", "$ref": "ServiceStates" } } }, "ServiceStates": { "id": "ServiceStates", "description": "The state of the service.", "type": "object", "properties": { "state": { "description": "Output only. The overall state of the service.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state means the service has config errors.", "The state means the service has IAM permission errors.", "The state means the service has functionality errors.", "The state means the service has no error.", "The state means the service disabled." ], "enum": [ "STATE_UNSPECIFIED", "CONFIG_FAILURE", "IAM_FAILURE", "FUNCTIONALITY_FAILURE", "ENABLED", "DISABLED" ] }, "iamPermissions": { "description": "Optional. Output only. The IAM permissions for the service.", "readOnly": true, "type": "array", "items": { "$ref": "IAMPermission" } } } }, "IAMPermission": { "id": "IAMPermission", "description": "The IAM permission status.", "type": "object", "properties": { "name": { "description": "Output only. The name of the permission.", "readOnly": true, "type": "string" }, "granted": { "description": "Output only. Whether the permission is granted.", "readOnly": true, "type": "boolean" } } }, "DatabaseProperties": { "id": "DatabaseProperties", "description": "Database Properties.", "type": "object", "properties": { "backupProperties": { "description": "Output only. Backup properties.", "readOnly": true, "$ref": "BackupProperties" }, "databaseType": { "description": "Output only. Type of the database. `HANA`, `DB2`, etc.", "readOnly": true, "type": "string", "enumDescriptions": [ "unspecified", "SAP HANA", "SAP MAX_DB", "IBM DB2", "Oracle Database", "Microsoft SQL Server", "SAP Sybase ASE" ], "enum": [ "DATABASE_TYPE_UNSPECIFIED", "HANA", "MAX_DB", "DB2", "ORACLE", "SQLSERVER", "ASE" ] } } }, "BackupProperties": { "id": "BackupProperties", "description": "Backup properties.", "type": "object", "properties": { "latestBackupTime": { "description": "The time when the latest backup was performed.", "type": "string", "format": "google-datetime" }, "latestBackupStatus": { "description": "Output only. The state of the latest backup.", "readOnly": true, "type": "string", "enumDescriptions": [ "unspecified", "SUCCESS state", "FAILURE state" ], "enum": [ "BACKUP_STATE_UNSPECIFIED", "BACKUP_STATE_SUCCESS", "BACKUP_STATE_FAILURE" ] } } }, "Product": { "id": "Product", "description": "Contains the details of a product.", "type": "object", "properties": { "name": { "description": "Optional. Name of the product.", "type": "string" }, "version": { "description": "Optional. Version of the product.", "type": "string" } } }, "WorkloadProfileHealth": { "id": "WorkloadProfileHealth", "description": "WorkloadProfileHealth contains the detailed health check of workload.", "type": "object", "properties": { "checkTime": { "description": "The time when the health check was performed.", "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. The health state of the workload.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified.", "Healthy workload.", "Unhealthy workload.", "Has critical issues.", "Unsupported." ], "enum": [ "HEALTH_STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "CRITICAL", "UNSUPPORTED" ] }, "componentsHealth": { "description": "The detailed condition reports of each component.", "type": "array", "items": { "$ref": "ComponentHealth" } } } }, "ComponentHealth": { "id": "ComponentHealth", "description": "HealthCondition contains the detailed health check of each component.", "type": "object", "properties": { "component": { "description": "The component of a workload.", "type": "string" }, "state": { "description": "Output only. The health state of the component.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified.", "Healthy workload.", "Unhealthy workload.", "Has critical issues.", "Unsupported." ], "enum": [ "HEALTH_STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "CRITICAL", "UNSUPPORTED" ] }, "componentHealthChecks": { "description": "The detailed health checks of the component.", "type": "array", "items": { "$ref": "HealthCheck" } }, "componentHealthType": { "description": "Output only. The type of the component health.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified", "required", "optional", "special" ], "enum": [ "TYPE_UNSPECIFIED", "TYPE_REQUIRED", "TYPE_OPTIONAL", "TYPE_SPECIAL" ] }, "subComponentsHealth": { "description": "Sub component health.", "type": "array", "items": { "$ref": "ComponentHealth" } } } }, "HealthCheck": { "id": "HealthCheck", "description": "HealthCheck contains the detailed health check of a component based on asource.", "type": "object", "properties": { "source": { "description": "Output only. The source of the health check.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The state of the health check.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified", "passed", "failed", "degraded", "skipped", "unsupported" ], "enum": [ "STATE_UNSPECIFIED", "PASSED", "FAILED", "DEGRADED", "SKIPPED", "UNSUPPORTED" ] }, "message": { "description": "Output only. The message of the health check.", "readOnly": true, "type": "string" }, "resource": { "description": "Output only. The resource the check performs on.", "readOnly": true, "$ref": "CloudResource" }, "metric": { "description": "Output only. The health check source metric name.", "readOnly": true, "type": "string" } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } } } }, "kind": "discovery#restDescription", "mtlsRootUrl": "https://workloadmanager.mtls.googleapis.com/", "ownerName": "Google", "protocol": "rest", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "id": "workloadmanager.projects.locations.list", "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." }, "get": { "id": "workloadmanager.projects.locations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "workloadmanager.projects.locations.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "workloadmanager.projects.locations.operations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "id": "workloadmanager.projects.locations.operations.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "cancel": { "id": "workloadmanager.projects.locations.operations.cancel", "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } }, "evaluations": { "methods": { "list": { "id": "workloadmanager.projects.locations.evaluations.list", "path": "v1/{+parent}/evaluations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value for ListEvaluationsRequest.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Filter to be applied when listing the evaluation results.", "location": "query", "type": "string" }, "orderBy": { "description": "Hint for how to order the results.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListEvaluationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Evaluations in a given project and location." }, "get": { "id": "workloadmanager.projects.locations.evaluations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Evaluation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Evaluation." }, "create": { "id": "workloadmanager.projects.locations.evaluations.create", "path": "v1/{+parent}/evaluations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "evaluationId": { "description": "Required. Id of the requesting object.", "location": "query", "type": "string" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Evaluation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Evaluation in a given project and location." }, "patch": { "id": "workloadmanager.projects.locations.evaluations.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the Evaluation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Evaluation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Evaluation." }, "delete": { "id": "workloadmanager.projects.locations.evaluations.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "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).", "location": "query", "type": "string" }, "force": { "description": "Optional. Followed the best practice from https://aip.dev/135#cascading-delete.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Evaluation." } }, "resources": { "executions": { "methods": { "list": { "id": "workloadmanager.projects.locations.evaluations.executions.list", "path": "v1/{+parent}/executions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource prefix of the Execution using the form: `projects/{project}/locations/{location}/evaluations/{evaluation}`.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExecutionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Executions in a given project and location." }, "get": { "id": "workloadmanager.projects.locations.evaluations.executions.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Execution" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Execution." }, "run": { "id": "workloadmanager.projects.locations.evaluations.executions.run", "path": "v1/{+name}/executions:run", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions:run", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The resource name of the Evaluation using the form: `projects/{project}/locations/{location}/evaluations/{evaluation}`.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RunEvaluationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Execution in a given project and location." }, "delete": { "id": "workloadmanager.projects.locations.evaluations.executions.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Execution." } }, "resources": { "results": { "methods": { "list": { "id": "workloadmanager.projects.locations.evaluations.executions.results.list", "path": "v1/{+parent}/results", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/results", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The execution results. Format: {parent}/evaluations/*/executions/*/results.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Filtering results.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExecutionResultsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the result of a single evaluation." } } }, "scannedResources": { "methods": { "list": { "id": "workloadmanager.projects.locations.evaluations.executions.scannedResources.list", "path": "v1/{+parent}/scannedResources", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/scannedResources", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent for ListScannedResourcesRequest.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "location": "path", "required": true, "type": "string" }, "rule": { "description": "Rule name.", "location": "query", "type": "string" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListScannedResourcesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List all scanned resources for a single Execution." } } } } } } }, "rules": { "methods": { "list": { "id": "workloadmanager.projects.locations.rules.list", "path": "v1/{+parent}/rules", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rules", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Filter based on primary_category, secondary_category.", "location": "query", "type": "string" }, "customRulesBucket": { "description": "The Cloud Storage bucket name for custom rules.", "location": "query", "type": "string" }, "evaluationType": { "description": "Optional. The evaluation type of the rules will be applied to. The Cloud Storage bucket name for custom rules.", "location": "query", "type": "string", "enumDescriptions": [ "Not specified.", "SAP best practices.", "SQL best practices.", "Customized best practices." ], "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "SAP", "SQL_SERVER", "OTHER" ] } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListRulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists rules in a given project." } } }, "insights": { "methods": { "writeInsight": { "id": "workloadmanager.projects.locations.insights.writeInsight", "path": "v1/{+location}/insights:writeInsight", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insights:writeInsight", "httpMethod": "POST", "parameters": { "location": { "description": "Required. The GCP location. The format is: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "location" ], "request": { "$ref": "WriteInsightRequest" }, "response": { "$ref": "WriteInsightResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Write the data insights to workload manager data warehouse." }, "delete": { "id": "workloadmanager.projects.locations.insights.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The system id of the SAP system resource to delete. Formatted as projects/{project}/locations/{location}/sapSystems/{sap_system_id}", "pattern": "^projects/[^/]+/locations/[^/]+/insights/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete the data insights from workload manager data warehouse." } } }, "deployments": { "methods": { "list": { "id": "workloadmanager.projects.locations.deployments.list", "path": "v1/{+parent}/deployments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter resource following https://google.aip.dev/160.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDeploymentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Deployments in a given project and location." }, "get": { "id": "workloadmanager.projects.locations.deployments.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Deployment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Deployment." }, "create": { "id": "workloadmanager.projects.locations.deployments.create", "path": "v1/{+parent}/deployments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "deploymentId": { "description": "Required. ID of the deployment.", "location": "query", "type": "string" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Deployment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Deployment in a given project and location." }, "delete": { "id": "workloadmanager.projects.locations.deployments.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "force": { "description": "Optional. If set to true, any actuation will also be deleted. Follows the best practice from https://aip.dev/135#cascading-delete.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Deployment." } }, "resources": { "actuations": { "methods": { "list": { "id": "workloadmanager.projects.locations.deployments.actuations.list", "path": "v1/{+parent}/actuations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource prefix of the Actuation using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListActuationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Actuations in a given project, location and deployment." }, "get": { "id": "workloadmanager.projects.locations.deployments.actuations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations/{actuationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/actuations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Actuation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Actuation." }, "create": { "id": "workloadmanager.projects.locations.deployments.actuations.create", "path": "v1/{+parent}/actuations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Actuation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new actuation for an existing Deployment." }, "delete": { "id": "workloadmanager.projects.locations.deployments.actuations.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations/{actuationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the actuation to delete. projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/actuations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Actuation." } } } } }, "discoveredprofiles": { "methods": { "list": { "id": "workloadmanager.projects.locations.discoveredprofiles.list", "path": "v1/{+parent}/discoveredprofiles", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value for ListDiscoveredProfilesRequest", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDiscoveredProfilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List discovered workload profiles" }, "get": { "id": "workloadmanager.projects.locations.discoveredprofiles.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles/{discoveredprofilesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredprofiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "WorkloadProfile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a discovered workload profile." } }, "resources": { "health": { "methods": { "get": { "id": "workloadmanager.projects.locations.discoveredprofiles.health.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles/{discoveredprofilesId}/health/{healthId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredprofiles/[^/]+/health/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "WorkloadProfileHealth" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get the health of a discovered workload profile." } } } } } } } } } }, "batchPath": "batch", "description": "Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.", "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "revision": "20260602", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "canonicalName": "Workload Manager", "version": "v1", "rootUrl": "https://workloadmanager.googleapis.com/", "servicePath": "", "documentationLink": "https://cloud.google.com/workload-manager/docs", "id": "workloadmanager:v1" }