Skip to content

Commit

Permalink
feat(workloadmanager): update the api
Browse files Browse the repository at this point in the history
#### workloadmanager:v1

The following keys were added:
- schemas.Evaluation.properties.evaluationType.type (Total Keys: 1)
- schemas.Execution.properties.resultSummary (Total Keys: 2)
- schemas.Insight.properties.torsoValidation.$ref (Total Keys: 1)
- schemas.Summary (Total Keys: 11)
- schemas.TorsoValidation (Total Keys: 8)
  • Loading branch information
yoshi-automation committed Dec 17, 2024
1 parent a2188e9 commit 2b6e6ea
Show file tree
Hide file tree
Showing 5 changed files with 125 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ <h3>Method Details</h3>
&quot;message&quot;: &quot;A String&quot;, # Output only. Message of the notice
},
],
&quot;resultSummary&quot;: { # Message for execution summary # Output only. [Output only] Result summary
&quot;failures&quot;: &quot;A String&quot;, # Output only. Number of failures
&quot;newFailures&quot;: &quot;A String&quot;, # Output only. Number of new failures compared to the previous execution
&quot;newFixes&quot;: &quot;A String&quot;, # Output only. Number of new fixes compared to the previous execution
},
&quot;ruleResults&quot;: [ # Output only. execution result summary per rule
{ # Message for execution result summary per rule
&quot;message&quot;: &quot;A String&quot;, # Execution message, if any
Expand Down Expand Up @@ -235,6 +240,11 @@ <h3>Method Details</h3>
&quot;message&quot;: &quot;A String&quot;, # Output only. Message of the notice
},
],
&quot;resultSummary&quot;: { # Message for execution summary # Output only. [Output only] Result summary
&quot;failures&quot;: &quot;A String&quot;, # Output only. Number of failures
&quot;newFailures&quot;: &quot;A String&quot;, # Output only. Number of new failures compared to the previous execution
&quot;newFixes&quot;: &quot;A String&quot;, # Output only. Number of new fixes compared to the previous execution
},
&quot;ruleResults&quot;: [ # Output only. execution result summary per rule
{ # Message for execution result summary per rule
&quot;message&quot;: &quot;A String&quot;, # Execution message, if any
Expand Down Expand Up @@ -301,6 +311,11 @@ <h3>Method Details</h3>
&quot;message&quot;: &quot;A String&quot;, # Output only. Message of the notice
},
],
&quot;resultSummary&quot;: { # Message for execution summary # Output only. [Output only] Result summary
&quot;failures&quot;: &quot;A String&quot;, # Output only. Number of failures
&quot;newFailures&quot;: &quot;A String&quot;, # Output only. Number of new failures compared to the previous execution
&quot;newFixes&quot;: &quot;A String&quot;, # Output only. Number of new fixes compared to the previous execution
},
&quot;ruleResults&quot;: [ # Output only. execution result summary per rule
{ # Message for execution result summary per rule
&quot;message&quot;: &quot;A String&quot;, # Execution message, if any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ <h3>Method Details</h3>
&quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
&quot;customRulesBucket&quot;: &quot;A String&quot;, # The Cloud Storage bucket name for custom rules.
&quot;description&quot;: &quot;A String&quot;, # Description of the Evaluation
&quot;evaluationType&quot;: &quot;A String&quot;, # Evaluation type
&quot;labels&quot;: { # Labels as key value pairs
&quot;a_key&quot;: &quot;A String&quot;,
},
Expand Down Expand Up @@ -246,6 +247,7 @@ <h3>Method Details</h3>
&quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
&quot;customRulesBucket&quot;: &quot;A String&quot;, # The Cloud Storage bucket name for custom rules.
&quot;description&quot;: &quot;A String&quot;, # Description of the Evaluation
&quot;evaluationType&quot;: &quot;A String&quot;, # Evaluation type
&quot;labels&quot;: { # Labels as key value pairs
&quot;a_key&quot;: &quot;A String&quot;,
},
Expand Down Expand Up @@ -311,6 +313,7 @@ <h3>Method Details</h3>
&quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
&quot;customRulesBucket&quot;: &quot;A String&quot;, # The Cloud Storage bucket name for custom rules.
&quot;description&quot;: &quot;A String&quot;, # Description of the Evaluation
&quot;evaluationType&quot;: &quot;A String&quot;, # Evaluation type
&quot;labels&quot;: { # Labels as key value pairs
&quot;a_key&quot;: &quot;A String&quot;,
},
Expand Down
9 changes: 9 additions & 0 deletions docs/dyn/workloadmanager_v1.projects.locations.insights.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,15 @@ <h3>Method Details</h3>
},
],
},
&quot;torsoValidation&quot;: { # The schema of torso workload validation data. # The insights data for workload validation of torso workloads.
&quot;agentVersion&quot;: &quot;A String&quot;, # Required. agent_version lists the version of the agent that collected this data.
&quot;instanceName&quot;: &quot;A String&quot;, # Required. instance_name lists the human readable name of the instance that the data comes from.
&quot;projectId&quot;: &quot;A String&quot;, # Required. project_id lists the human readable cloud project that the data comes from.
&quot;validationDetails&quot;: { # Required. validation_details contains the pairs of validation data: field name &amp; field value.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;workloadType&quot;: &quot;A String&quot;, # Required. workload_type specifies the type of torso workload.
},
},
&quot;requestId&quot;: &quot;A String&quot;, # 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).
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h1><a href="workloadmanager_v1.html">Workload Manager API</a> . <a href="worklo
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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`.</p>
<p class="firstline">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`.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand All @@ -95,7 +95,7 @@ <h2>Instance Methods</h2>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>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&#x27;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`.
<pre>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&#x27;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`.

Args:
name: string, The name of the operation resource to be cancelled. (required)
Expand Down
98 changes: 96 additions & 2 deletions googleapiclient/discovery_cache/documents/workloadmanager.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@
"operations": {
"methods": {
"cancel": {
"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`.",
"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`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "workloadmanager.projects.locations.operations.cancel",
Expand Down Expand Up @@ -772,7 +772,7 @@
}
}
},
"revision": "20241016",
"revision": "20241209",
"rootUrl": "https://workloadmanager.googleapis.com/",
"schemas": {
"AgentCommand": {
Expand Down Expand Up @@ -857,6 +857,24 @@
"description": "Description of the Evaluation",
"type": "string"
},
"evaluationType": {
"description": "Evaluation type",
"enum": [
"EVALUATION_TYPE_UNSPECIFIED",
"SAP",
"SQL_SERVER",
"OTHER",
"SCC_IAC"
],
"enumDescriptions": [
"Not specified",
"SAP best practices",
"SQL best practices",
"Customized best practices",
"SCC IaC (Infra as Code) best practices"
],
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
Expand Down Expand Up @@ -952,6 +970,11 @@
"readOnly": true,
"type": "array"
},
"resultSummary": {
"$ref": "Summary",
"description": "Output only. [Output only] Result summary",
"readOnly": true
},
"ruleResults": {
"description": "Output only. execution result summary per rule",
"items": {
Expand Down Expand Up @@ -1122,6 +1145,10 @@
"sqlserverValidation": {
"$ref": "SqlserverValidation",
"description": "The insights data for the sqlserver workload validation."
},
"torsoValidation": {
"$ref": "TorsoValidation",
"description": "The insights data for workload validation of torso workloads."
}
},
"type": "object"
Expand Down Expand Up @@ -2240,6 +2267,73 @@
},
"type": "object"
},
"Summary": {
"description": "Message for execution summary",
"id": "Summary",
"properties": {
"failures": {
"description": "Output only. Number of failures",
"format": "int64",
"readOnly": true,
"type": "string"
},
"newFailures": {
"description": "Output only. Number of new failures compared to the previous execution",
"format": "int64",
"readOnly": true,
"type": "string"
},
"newFixes": {
"description": "Output only. Number of new fixes compared to the previous execution",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"TorsoValidation": {
"description": "The schema of torso workload validation data.",
"id": "TorsoValidation",
"properties": {
"agentVersion": {
"description": "Required. agent_version lists the version of the agent that collected this data.",
"type": "string"
},
"instanceName": {
"description": "Required. instance_name lists the human readable name of the instance that the data comes from.",
"type": "string"
},
"projectId": {
"description": "Required. project_id lists the human readable cloud project that the data comes from.",
"type": "string"
},
"validationDetails": {
"additionalProperties": {
"type": "string"
},
"description": "Required. validation_details contains the pairs of validation data: field name & field value.",
"type": "object"
},
"workloadType": {
"description": "Required. workload_type specifies the type of torso workload.",
"enum": [
"WORKLOAD_TYPE_UNSPECIFIED",
"MYSQL",
"ORACLE",
"REDIS"
],
"enumDescriptions": [
"Unspecified workload type.",
"MySQL workload.",
"Oracle workload.",
"Redis workload."
],
"type": "string"
}
},
"type": "object"
},
"ViolationDetails": {
"description": "Message describing the violation in an evaluation result.",
"id": "ViolationDetails",
Expand Down

0 comments on commit 2b6e6ea

Please sign in to comment.