Skip to content

Commit

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

The following keys were added:
- resources.projects.resources.locations.resources.batches.methods.analyze (Total Keys: 12)
- schemas.AnalyzeBatchRequest (Total Keys: 3)

The following keys were changed:
- endpoints (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Mar 26, 2024
1 parent 2ebeb56 commit d65b377
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 6 deletions.
45 changes: 45 additions & 0 deletions docs/dyn/dataproc_v1.projects.locations.batches.html
Expand Up @@ -74,6 +74,9 @@

<h1><a href="dataproc_v1.html">Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.locations.html">locations</a> . <a href="dataproc_v1.projects.locations.batches.html">batches</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#analyze">analyze(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Analyze a Batch for possible recommendations and insights.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand All @@ -93,6 +96,48 @@ <h2>Instance Methods</h2>
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="analyze">analyze(name, body=None, x__xgafv=None)</code>
<pre>Analyze a Batch for possible recommendations and insights.

Args:
name: string, Required. The fully qualified name of the batch to analyze in the format &quot;projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID&quot; (required)
body: object, The request body.
The object takes the form of:

{ # A request to analyze a batch workload.
&quot;requestId&quot;: &quot;A String&quot;, # Optional. A unique ID used to identify the request. If the service receives two AnalyzeBatchRequest (http://cloud/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.AnalyzeBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first request created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
}

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

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
&quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
&quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}.
&quot;response&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>

<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
Expand Down
51 changes: 45 additions & 6 deletions googleapiclient/discovery_cache/documents/dataproc.v1.json
Expand Up @@ -18,18 +18,18 @@
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/",
"location": "me-central2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataproc.europe-west3.rep.googleapis.com/",
"location": "europe-west3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataproc.europe-west9.rep.googleapis.com/",
"location": "europe-west9"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/",
"location": "me-central2"
}
],
"fullyEncodeReservedExpansion": true,
Expand Down Expand Up @@ -358,6 +358,34 @@
},
"batches": {
"methods": {
"analyze": {
"description": "Analyze a Batch for possible recommendations and insights.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}:analyze",
"httpMethod": "POST",
"id": "dataproc.projects.locations.batches.analyze",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The fully qualified name of the batch to analyze in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:analyze",
"request": {
"$ref": "AnalyzeBatchRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a batch workload that executes asynchronously.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches",
Expand Down Expand Up @@ -3044,7 +3072,7 @@
}
}
},
"revision": "20240309",
"revision": "20240320",
"rootUrl": "https://dataproc.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
Expand All @@ -3063,6 +3091,17 @@
},
"type": "object"
},
"AnalyzeBatchRequest": {
"description": "A request to analyze a batch workload.",
"id": "AnalyzeBatchRequest",
"properties": {
"requestId": {
"description": "Optional. A unique ID used to identify the request. If the service receives two AnalyzeBatchRequest (http://cloud/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.AnalyzeBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first request created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"type": "string"
}
},
"type": "object"
},
"AnalyzeOperationMetadata": {
"description": "Metadata describing the Analyze operation.",
"id": "AnalyzeOperationMetadata",
Expand Down

0 comments on commit d65b377

Please sign in to comment.