close()

Close httplib2 connections.

create(parent, body=None, monitoredAgentId=None, x__xgafv=None)

Creates a new MonitoredAgent in a specific Location.

Args:
  parent: string, Required. The resource name of the Location to create the MonitoredAgent in. Format: `projects/{project}/locations/{location}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A monitored agent in a specific Location.
  "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored.
    "agent": "A String", # Required. The full resource name of the agent to monitor. For REASONING_ENGINE, format: `projects/{project}/locations/{location}/reasoningEngines/{agent}`
    "agentType": "A String", # Required. The type of the agent.
    "location": "A String", # Output only. The GCP location (region) of the agent resource (e.g. `us-central1`).
  },
  "createTime": "A String", # Output only. The time the MonitoredAgent was created.
  "displayName": "A String", # Optional. The display name of the MonitoredAgent.
  "logBuckets": [ # Optional. The log buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/buckets/{bucket}`
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the MonitoredAgent.
  "observabilityBuckets": [ # Optional. The observability buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`
    "A String",
  ],
  "state": "A String", # Output only. The current state of the agent's enablement.
  "statusMessage": "A String", # Output only. A brief message explaining the current state.
  "updateTime": "A String", # Output only. The time the MonitoredAgent was last updated.
}

  monitoredAgentId: string, Required. The ID to use for the MonitoredAgent, which will become the final component of the MonitoredAgent's resource name.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A monitored agent in a specific Location.
  "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored.
    "agent": "A String", # Required. The full resource name of the agent to monitor. For REASONING_ENGINE, format: `projects/{project}/locations/{location}/reasoningEngines/{agent}`
    "agentType": "A String", # Required. The type of the agent.
    "location": "A String", # Output only. The GCP location (region) of the agent resource (e.g. `us-central1`).
  },
  "createTime": "A String", # Output only. The time the MonitoredAgent was created.
  "displayName": "A String", # Optional. The display name of the MonitoredAgent.
  "logBuckets": [ # Optional. The log buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/buckets/{bucket}`
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the MonitoredAgent.
  "observabilityBuckets": [ # Optional. The observability buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`
    "A String",
  ],
  "state": "A String", # Output only. The current state of the agent's enablement.
  "statusMessage": "A String", # Output only. A brief message explaining the current state.
  "updateTime": "A String", # Output only. The time the MonitoredAgent was last updated.
}

delete(name, x__xgafv=None)

Deletes a specific MonitoredAgent.

Args:
  name: string, Required. The name of the MonitoredAgent resource to be deleted. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}

disable(name, body=None, x__xgafv=None)

Disables a specific MonitoredAgent.

Args:
name: string, Required. The name of the MonitoredAgent resource to be disabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required)
body: object, The request body.
The object takes the form of:

{ # Request message for AgentAnomalyDetectionService.DisableMonitoredAgent.
}

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.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

enable(name, body=None, x__xgafv=None)

Enables a specific MonitoredAgent.

Args:
name: string, Required. The name of the MonitoredAgent resource to be enabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required)
body: object, The request body.
The object takes the form of:

{ # Request message for AgentAnomalyDetectionService.EnableMonitoredAgent.
}

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.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets the details of a specific MonitoredAgent.

Args:
  name: string, Required. The name of the MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A monitored agent in a specific Location.
  "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored.
    "agent": "A String", # Required. The full resource name of the agent to monitor. For REASONING_ENGINE, format: `projects/{project}/locations/{location}/reasoningEngines/{agent}`
    "agentType": "A String", # Required. The type of the agent.
    "location": "A String", # Output only. The GCP location (region) of the agent resource (e.g. `us-central1`).
  },
  "createTime": "A String", # Output only. The time the MonitoredAgent was created.
  "displayName": "A String", # Optional. The display name of the MonitoredAgent.
  "logBuckets": [ # Optional. The log buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/buckets/{bucket}`
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the MonitoredAgent.
  "observabilityBuckets": [ # Optional. The observability buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`
    "A String",
  ],
  "state": "A String", # Output only. The current state of the agent's enablement.
  "statusMessage": "A String", # Output only. A brief message explaining the current state.
  "updateTime": "A String", # Output only. The time the MonitoredAgent was last updated.
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists MonitoredAgents in a specific Location.

Args:
  parent: string, Required. The resource name of the Location to list the MonitoredAgents from. Format: `projects/{project}/locations/{location}` (required)
  filter: string, Optional. Optional AIP-160 filter, currently restricted to a single equality predicate on `state`: state = ACTIVE state = DISABLED state = ENABLING The value must be the exact name of a `MonitoredAgent.EnablementState` constant (case-sensitive): `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. (The proto reserves ordinals for additional future states like NEEDS_ACTION; this allow-list grows when the proto adds them.) A blank or absent filter returns every MonitoredAgent in the parent regardless of state. Anything else returns INVALID_ARGUMENT.
  pageSize: integer, Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.
  pageToken: string, Optional. The standard list page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AgentAnomalyDetectionService.ListMonitoredAgents.
  "monitoredAgents": [ # A list of MonitoredAgents that matches the specified filter in the request.
    { # A monitored agent in a specific Location.
      "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored.
        "agent": "A String", # Required. The full resource name of the agent to monitor. For REASONING_ENGINE, format: `projects/{project}/locations/{location}/reasoningEngines/{agent}`
        "agentType": "A String", # Required. The type of the agent.
        "location": "A String", # Output only. The GCP location (region) of the agent resource (e.g. `us-central1`).
      },
      "createTime": "A String", # Output only. The time the MonitoredAgent was created.
      "displayName": "A String", # Optional. The display name of the MonitoredAgent.
      "logBuckets": [ # Optional. The log buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/buckets/{bucket}`
        "A String",
      ],
      "name": "A String", # Identifier. The resource name of the MonitoredAgent.
      "observabilityBuckets": [ # Optional. The observability buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`
        "A String",
      ],
      "state": "A String", # Output only. The current state of the agent's enablement.
      "statusMessage": "A String", # Output only. A brief message explaining the current state.
      "updateTime": "A String", # Output only. The time the MonitoredAgent was last updated.
    },
  ],
  "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.
  "totalSize": 42, # The total number of MonitoredAgents in the request scope after the request `filter` (if any) is applied. With no filter this is the unconditional count of MonitoredAgents in the parent; with `filter = "state = ACTIVE"` it is the active-agent count, and so on.
}

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.

Agent Platform API . projects . locations . monitoredAgents

Instance Methods

Method Details