close()

Close httplib2 connections.

create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)

Creates a new Service in a given project and location.

Args:
parent: string, Required. The project and location to create the Service in. Expected format: `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:

{ # Represents a user-defined Service.
"agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
"content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
"a_key": "", # Properties of the object.
},
"type": "A String", # Required. The type of the agent spec content.
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
"displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
"endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
"content": { # Optional. The content of the endpoint spec. Reserved for future use.
"a_key": "", # Properties of the object.
},
"type": "A String", # Required. The type of the endpoint spec content.
},
"interfaces": [ # Optional. The connection details for the Service.
{ # Represents the connection details for an Agent or MCP Server.
"protocolBinding": "A String", # Required. The protocol binding of the interface.
"url": "A String", # Required. The destination URL.
},
],
"mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
"content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
"a_key": "", # Properties of the object.
},
"type": "A String", # Required. The type of the MCP Server spec content.
},
"name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
"registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
"updateTime": "A String", # Output only. Update time.
}

requestId: string, Optional. 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 the 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).
serviceId: string, Required. The ID to use for the service, which will become the final component of the service's resource name. This value should be 4-63 characters, and valid characters are `/a-z-/`.
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.
},
}

delete(name, requestId=None, x__xgafv=None)

Deletes a single Service.

Args:
name: string, Required. The name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`. (required)
requestId: string, Optional. 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 after the first request. For example, consider a situation where you make an initial request and the 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).
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 details of a single Service.

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

Returns:
  An object of the form:

    { # Represents a user-defined Service.
  "agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
    "content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
      "a_key": "", # Properties of the object.
    },
    "type": "A String", # Required. The type of the agent spec content.
  },
  "createTime": "A String", # Output only. Create time.
  "description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
  "displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
  "endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
    "content": { # Optional. The content of the endpoint spec. Reserved for future use.
      "a_key": "", # Properties of the object.
    },
    "type": "A String", # Required. The type of the endpoint spec content.
  },
  "interfaces": [ # Optional. The connection details for the Service.
    { # Represents the connection details for an Agent or MCP Server.
      "protocolBinding": "A String", # Required. The protocol binding of the interface.
      "url": "A String", # Required. The destination URL.
    },
  ],
  "mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
    "content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
      "a_key": "", # Properties of the object.
    },
    "type": "A String", # Required. The type of the MCP Server spec content.
  },
  "name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
  "registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
  "updateTime": "A String", # Output only. Update time.
}

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

Lists Services in a given project and location.

Args:
  parent: string, Required. The project and location to list services in. Expected format: `projects/{project}/locations/{location}`. (required)
  filter: string, Optional. A query string used to filter the list of services returned. The filter expression must follow AIP-160 syntax. Filtering is supported on the `name`, `display_name`, `description`, and `labels` fields. Some examples: * `name = "projects/p1/locations/l1/services/s1"` * `display_name = "my-service"` * `description : "myservice description"` * `labels.env = "prod"`
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  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 Services
  "nextPageToken": "A String", # A token identifying a page of results the server should return. Used in page_token.
  "services": [ # The list of Service resources matching the parent and filter criteria in the request. Each Service resource follows the format: `projects/{project}/locations/{location}/services/{service}`.
    { # Represents a user-defined Service.
      "agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
        "content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
          "a_key": "", # Properties of the object.
        },
        "type": "A String", # Required. The type of the agent spec content.
      },
      "createTime": "A String", # Output only. Create time.
      "description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
      "displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
      "endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
        "content": { # Optional. The content of the endpoint spec. Reserved for future use.
          "a_key": "", # Properties of the object.
        },
        "type": "A String", # Required. The type of the endpoint spec content.
      },
      "interfaces": [ # Optional. The connection details for the Service.
        { # Represents the connection details for an Agent or MCP Server.
          "protocolBinding": "A String", # Required. The protocol binding of the interface.
          "url": "A String", # Required. The destination URL.
        },
      ],
      "mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
        "content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
          "a_key": "", # Properties of the object.
        },
        "type": "A String", # Required. The type of the MCP Server spec content.
      },
      "name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
      "registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
      "updateTime": "A String", # Output only. Update time.
    },
  ],
}

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.

patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single Service.

Args:
name: string, Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`. (required)
body: object, The request body.
The object takes the form of:

{ # Represents a user-defined Service.
"agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
"content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
"a_key": "", # Properties of the object.
},
"type": "A String", # Required. The type of the agent spec content.
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
"displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
"endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
"content": { # Optional. The content of the endpoint spec. Reserved for future use.
"a_key": "", # Properties of the object.
},
"type": "A String", # Required. The type of the endpoint spec content.
},
"interfaces": [ # Optional. The connection details for the Service.
{ # Represents the connection details for an Agent or MCP Server.
"protocolBinding": "A String", # Required. The protocol binding of the interface.
"url": "A String", # Required. The destination URL.
},
],
"mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
"content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
"a_key": "", # Properties of the object.
},
"type": "A String", # Required. The type of the MCP Server spec content.
},
"name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
"registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
"updateTime": "A String", # Output only. Update time.
}

requestId: string, Optional. 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 the 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, Optional. Field mask is used to specify the fields to be overwritten in the Service 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 present in the request 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.
"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.
},
}

Agent Registry API . projects . locations . services

Instance Methods

Method Details