Close httplib2 connections.
Gets a DiscoveredAPIOperation in a given project, location, ApiObservation and ApiOperation.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the DiscoveredAPIOperations in a given project, location and ApiObservation.
Retrieves the next page of results.
close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets a DiscoveredAPIOperation in a given project, location, ApiObservation and ApiOperation.
Args:
name: string, Required. The name of the DiscoveredApiOperation to retrieve. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # DiscoveredApiOperation represents an API Operation observed in one of the sources.
"classification": "A String", # Output only. The classification of the discovered API operation.
"count": "A String", # Optional. The number of occurrences of this API Operation.
"createTime": "A String", # Output only. Create time stamp of the discovered API operation in API Hub.
"firstSeenTime": "A String", # Optional. First seen time stamp
"httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # Optional. An HTTP Operation.
"httpOperation": { # The HTTP Operation. # Required. An HTTP Operation.
"method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"description": "A String", # Optional. A short description for the path applicable to all operations.
"path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
},
},
"pathParams": [ # Optional. Path params of HttpOperation
{ # HTTP Path parameter.
"dataType": "A String", # Optional. Data type of path param
"position": 42, # Optional. Segment location in the path, 1-indexed
},
],
"queryParams": { # Optional. Query params of HttpOperation
"a_key": { # An aggregation of HTTP query parameter occurrences.
"count": "A String", # Optional. The number of occurrences of this query parameter across transactions.
"dataType": "A String", # Optional. Data type of path param
"name": "A String", # Required. Name of query param
},
},
"request": { # An aggregation of HTTP requests. # Optional. Request metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
},
"response": { # An aggregation of HTTP responses. # Optional. Response metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
"responseCodes": { # Optional. Map of status code to observed count
"a_key": "A String",
},
},
},
"lastSeenTime": "A String", # Optional. Last seen time stamp
"matchResults": [ # Output only. The list of matched results for the discovered API operation. This will be populated only if the classification is known. The current usecase is for a single match. Keeping it repeated to support multiple matches in future.
{ # MatchResult represents the result of matching a discovered API operation with a catalog API operation.
"name": "A String", # Output only. The name of the matched API Operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
},
],
"name": "A String", # Identifier. The name of the discovered API Operation. Format: `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation}`
"sourceMetadata": { # SourceMetadata represents the metadata for a resource at the source. # Output only. The metadata of the source from which the api operation was collected.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
"updateTime": "A String", # Output only. Update time stamp of the discovered API operation in API Hub.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the DiscoveredAPIOperations in a given project, location and ApiObservation.
Args:
parent: string, Required. The parent, which owns this collection of DiscoveredApiOperations. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation} (required)
pageSize: integer, Optional. DiscoveredApiOperations 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 `ListDiscoveredApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDiscoveredApiApiOperations` 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 DiscoveredApiOperations
"discoveredApiOperations": [ # The DiscoveredApiOperations from the specified project, location and DiscoveredApiObservation.
{ # DiscoveredApiOperation represents an API Operation observed in one of the sources.
"classification": "A String", # Output only. The classification of the discovered API operation.
"count": "A String", # Optional. The number of occurrences of this API Operation.
"createTime": "A String", # Output only. Create time stamp of the discovered API operation in API Hub.
"firstSeenTime": "A String", # Optional. First seen time stamp
"httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # Optional. An HTTP Operation.
"httpOperation": { # The HTTP Operation. # Required. An HTTP Operation.
"method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"description": "A String", # Optional. A short description for the path applicable to all operations.
"path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
},
},
"pathParams": [ # Optional. Path params of HttpOperation
{ # HTTP Path parameter.
"dataType": "A String", # Optional. Data type of path param
"position": 42, # Optional. Segment location in the path, 1-indexed
},
],
"queryParams": { # Optional. Query params of HttpOperation
"a_key": { # An aggregation of HTTP query parameter occurrences.
"count": "A String", # Optional. The number of occurrences of this query parameter across transactions.
"dataType": "A String", # Optional. Data type of path param
"name": "A String", # Required. Name of query param
},
},
"request": { # An aggregation of HTTP requests. # Optional. Request metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
},
"response": { # An aggregation of HTTP responses. # Optional. Response metadata.
"headers": { # Optional. Unordered map from header name to header metadata
"a_key": { # An aggregation of HTTP header occurrences.
"count": "A String", # The number of occurrences of this Header across transactions.
"dataType": "A String", # Data type of header
"name": "A String", # Header name.
},
},
"responseCodes": { # Optional. Map of status code to observed count
"a_key": "A String",
},
},
},
"lastSeenTime": "A String", # Optional. Last seen time stamp
"matchResults": [ # Output only. The list of matched results for the discovered API operation. This will be populated only if the classification is known. The current usecase is for a single match. Keeping it repeated to support multiple matches in future.
{ # MatchResult represents the result of matching a discovered API operation with a catalog API operation.
"name": "A String", # Output only. The name of the matched API Operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
},
],
"name": "A String", # Identifier. The name of the discovered API Operation. Format: `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation}`
"sourceMetadata": { # SourceMetadata represents the metadata for a resource at the source. # Output only. The metadata of the source from which the api operation was collected.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
"updateTime": "A String", # Output only. Update time stamp of the discovered API operation in API Hub.
},
],
"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.
}
list_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.