Skip to content

Commit

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

The following keys were added:
- resources.projects.resources.locations.resources.endpoints.methods.patch (Total Keys: 17)
- schemas.Endpoint.properties.threatExceptions (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Dec 13, 2022
1 parent e7a24b2 commit d7ca9eb
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 1 deletion.
71 changes: 71 additions & 0 deletions docs/dyn/ids_v1.projects.locations.endpoints.html
Expand Up @@ -95,6 +95,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Endpoint.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
Expand Down Expand Up @@ -128,6 +131,9 @@ <h3>Method Details</h3>
&quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
&quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
&quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
&quot;A String&quot;,
],
&quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
}
Expand Down Expand Up @@ -225,6 +231,9 @@ <h3>Method Details</h3>
&quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
&quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
&quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
&quot;A String&quot;,
],
&quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
}</pre>
Expand Down Expand Up @@ -310,6 +319,9 @@ <h3>Method Details</h3>
&quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
&quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
&quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
&quot;A String&quot;,
],
&quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
},
Expand All @@ -335,6 +347,65 @@ <h3>Method Details</h3>
</pre>
</div>

<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single Endpoint.

Args:
name: string, Output only. The name of the endpoint. (required)
body: object, The request body.
The object takes the form of:

{ # Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
&quot;description&quot;: &quot;A String&quot;, # User-provided description of the endpoint
&quot;endpointForwardingRule&quot;: &quot;A String&quot;, # Output only. The fully qualified URL of the endpoint&#x27;s ILB Forwarding Rule.
&quot;endpointIp&quot;: &quot;A String&quot;, # Output only. The IP address of the IDS Endpoint&#x27;s ILB.
&quot;labels&quot;: { # The labels of the endpoint.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the endpoint.
&quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
&quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
&quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
&quot;A String&quot;,
],
&quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
}

requestId: string, 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 t he 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).
updateMask: string, Field mask is used to specify the fields to be overwritten in the Endpoint 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. If the user does not provide a mask then all fields will be overwritten.
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 response of the operation in case of success. 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="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Expand Down
48 changes: 47 additions & 1 deletion googleapiclient/discovery_cache/documents/ids.v1.json
Expand Up @@ -349,6 +349,45 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the parameters of a single Endpoint.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
"httpMethod": "PATCH",
"id": "ids.projects.locations.endpoints.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The name of the endpoint.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "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 t he 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"
},
"updateMask": {
"description": "Field mask is used to specify the fields to be overwritten in the Endpoint 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. If the user does not provide a mask then all fields will be overwritten.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Endpoint"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy",
Expand Down Expand Up @@ -535,7 +574,7 @@
}
}
},
"revision": "20220831",
"revision": "20221113",
"rootUrl": "https://ids.googleapis.com/",
"schemas": {
"AuditConfig": {
Expand Down Expand Up @@ -699,6 +738,13 @@
"readOnly": true,
"type": "string"
},
"threatExceptions": {
"description": "List of threat IDs to be excepted from generating alerts.",
"items": {
"type": "string"
},
"type": "array"
},
"trafficLogs": {
"description": "Whether the endpoint should report traffic logs in addition to threat logs.",
"type": "boolean"
Expand Down

0 comments on commit d7ca9eb

Please sign in to comment.