diff --git a/docs/dyn/apim_v1alpha.projects.locations.html b/docs/dyn/apim_v1alpha.projects.locations.html index 804b5f88be2..7c0dbb7de19 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.html +++ b/docs/dyn/apim_v1alpha.projects.locations.html @@ -98,6 +98,12 @@
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
+
+ listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)
ListApiObservationTags lists all extant tags on any observation in the given project.
+
+ listApiObservationTags_next()
Retrieves the next page of results.
Retrieves the next page of results.
@@ -169,6 +175,44 @@listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ ListApiObservationTags lists all extant tags on any observation in the given project. + +Args: + parent: string, Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} (required) + pageSize: integer, Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Message for response to listing tags + "apiObservationTags": [ # The tags from the specified project + "A String", + ], + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. +}+
listApiObservationTags_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
list_next()
Retrieves the next page of results. diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html index 358500ee4a6..e4eec036770 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html +++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html @@ -82,7 +82,7 @@Instance Methods
GetApiOperation retrieves a single ApiOperation by name.
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation
+ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.
Retrieves the next page of results.
@@ -154,7 +154,7 @@Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation +ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation. Args: parent: string, Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (required) diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html index 95b3e84f734..3712e36d21a 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html +++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html @@ -79,6 +79,9 @@Instance Methods
Returns the apiOperations Resource.
++
+batchEditTags(parent, body=None, x__xgafv=None)
BatchEditTagsApiObservations adds or removes Tags for ApiObservations.
Close httplib2 connections.
@@ -87,11 +90,66 @@Instance Methods
GetApiObservation retrieves a single ApiObservation by name.
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
ListApiObservations gets all ApiObservations for a given project and location and ObservationJob
+ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.
Retrieves the next page of results.
Method Details
+++batchEditTags(parent, body=None, x__xgafv=None)
+BatchEditTagsApiObservations adds or removes Tags for ApiObservations. + +Args: + parent: string, Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required) + body: object, The request body. + The object takes the form of: + +{ # Message for requesting batch edit tags for ApiObservations + "requests": [ # Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch. + { # Message for requesting edit tags for ApiObservation + "apiObservationId": "A String", # Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443" + "tagActions": [ # Required. Tag actions to be applied + { # Message for edit tag action + "action": "A String", # Required. Action to be applied + "tag": "A String", # Required. Tag to be added or removed + }, + ], + }, + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Message for response to edit Tags for ApiObservations + "apiObservations": [ # ApiObservations that were changed + { # Message describing ApiObservation object + "apiOperationCount": "A String", # The number of observed API Operations. + "createTime": "A String", # Create time stamp + "hostname": "A String", # The hostname of requests processed for this Observation. + "lastEventDetectedTime": "A String", # Last event detected time stamp + "name": "A String", # Identifier. Name of resource + "serverIps": [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`. + "A String", + ], + "sourceLocations": [ # Location of the Observation Source, for example "us-central1" or "europe-west1." + "A String", + ], + "style": "A String", # Style of ApiObservation + "tags": [ # User-defined tags to organize and sort + "A String", + ], + "updateTime": "A String", # Update time stamp + }, + ], +}+close()
Close httplib2 connections.@@ -133,7 +191,7 @@Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListApiObservations gets all ApiObservations for a given project and location and ObservationJob +ListApiObservations gets all ApiObservations for a given project and location and ObservationJob. Args: parent: string, Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required) diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html index 13878a4ac0e..b8008fb41a7 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html +++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html @@ -99,7 +99,7 @@Instance Methods
GetObservationJob retrieves a single ObservationJob by name.
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
ListObservationJobs gets all ObservationJobs for a given project and location
+ListObservationJobs gets all ObservationJobs for a given project and location.
Retrieves the next page of results.
@@ -303,7 +303,7 @@Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListObservationJobs gets all ObservationJobs for a given project and location +ListObservationJobs gets all ObservationJobs for a given project and location. Args: parent: string, Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} (required) diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html index 2bc60f346a2..da4f26b7893 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html +++ b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html @@ -88,7 +88,7 @@Instance Methods
GetObservationSource retrieves a single ObservationSource by name.
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
ListObservationSources gets all ObservationSources for a given project and location
+ListObservationSources gets all ObservationSources for a given project and location.
Retrieves the next page of results.
@@ -220,7 +220,7 @@Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListObservationSources gets all ObservationSources for a given project and location +ListObservationSources gets all ObservationSources for a given project and location. Args: parent: string, Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} (required) diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json index 03cb5ee4a9d..88ba6e3aa2f 100644 --- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json @@ -174,6 +174,42 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"listApiObservationTags": { +"description": "ListApiObservationTags lists all extant tags on any observation in the given project.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:listApiObservationTags", +"httpMethod": "GET", +"id": "apim.projects.locations.listApiObservationTags", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}:listApiObservationTags", +"response": { +"$ref": "ListApiObservationTagsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -324,7 +360,7 @@ ] }, "list": { -"description": "ListObservationJobs gets all ObservationJobs for a given project and location", +"description": "ListObservationJobs gets all ObservationJobs for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.list", @@ -363,6 +399,34 @@ "resources": { "apiObservations": { "methods": { +"batchEditTags": { +"description": "BatchEditTagsApiObservations adds or removes Tags for ApiObservations.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations:batchEditTags", +"httpMethod": "POST", +"id": "apim.projects.locations.observationJobs.apiObservations.batchEditTags", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/apiObservations:batchEditTags", +"request": { +"$ref": "BatchEditTagsApiObservationsRequest" +}, +"response": { +"$ref": "BatchEditTagsApiObservationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "GetApiObservation retrieves a single ApiObservation by name.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}", @@ -389,7 +453,7 @@ ] }, "list": { -"description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob", +"description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.list", @@ -454,7 +518,7 @@ ] }, "list": { -"description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation", +"description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.apiOperations.list", @@ -586,7 +650,7 @@ ] }, "list": { -"description": "ListObservationSources gets all ObservationSources for a given project and location", +"description": "ListObservationSources gets all ObservationSources for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources", "httpMethod": "GET", "id": "apim.projects.locations.observationSources.list", @@ -751,7 +815,7 @@ } } }, -"revision": "20240701", +"revision": "20240717", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { @@ -856,6 +920,34 @@ }, "type": "object" }, +"BatchEditTagsApiObservationsRequest": { +"description": "Message for requesting batch edit tags for ApiObservations", +"id": "BatchEditTagsApiObservationsRequest", +"properties": { +"requests": { +"description": "Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.", +"items": { +"$ref": "EditTagsApiObservationsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BatchEditTagsApiObservationsResponse": { +"description": "Message for response to edit Tags for ApiObservations", +"id": "BatchEditTagsApiObservationsResponse", +"properties": { +"apiObservations": { +"description": "ApiObservations that were changed", +"items": { +"$ref": "ApiObservation" +}, +"type": "array" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -868,6 +960,24 @@ "properties": {}, "type": "object" }, +"EditTagsApiObservationsRequest": { +"description": "Message for requesting edit tags for ApiObservation", +"id": "EditTagsApiObservationsRequest", +"properties": { +"apiObservationId": { +"description": "Required. Identifier of ApiObservation need to be edit tags Format example: \"apigee.googleapis.com|us-west1|443\"", +"type": "string" +}, +"tagActions": { +"description": "Required. Tag actions to be applied", +"items": { +"$ref": "TagAction" +}, +"type": "array" +} +}, +"type": "object" +}, "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); }", "id": "Empty", @@ -1110,6 +1220,24 @@ }, "type": "object" }, +"ListApiObservationTagsResponse": { +"description": "Message for response to listing tags", +"id": "ListApiObservationTagsResponse", +"properties": { +"apiObservationTags": { +"description": "The tags from the specified project", +"items": { +"type": "string" +}, +"type": "array" +}, +"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" +} +}, +"type": "object" +}, "ListApiObservationsResponse": { "description": "Message for response to listing ApiObservations", "id": "ListApiObservationsResponse", @@ -1472,6 +1600,31 @@ } }, "type": "object" +}, +"TagAction": { +"description": "Message for edit tag action", +"id": "TagAction", +"properties": { +"action": { +"description": "Required. Action to be applied", +"enum": [ +"ACTION_UNSPECIFIED", +"ADD", +"REMOVE" +], +"enumDescriptions": [ +"Unspecified.", +"Addition of a Tag.", +"Removal of a Tag." +], +"type": "string" +}, +"tag": { +"description": "Required. Tag to be added or removed", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "",