@pulumi/gcp/agentregistry/service.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Service manages a service in a management boundary
 *
 * ## Example Usage
 *
 * ### Agent Registry Service Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.agentregistry.Service("default", {
 *     location: "us-central1",
 *     serviceId: "service",
 *     description: "My basic agent registry service",
 *     displayName: "My Service",
 *     interfaces: [{
 *         url: "https://www.google.com/service",
 *         protocolBinding: "GRPC",
 *     }],
 *     agentSpec: {
 *         type: "NO_SPEC",
 *     },
 * });
 * ```
 * ### Agent Registry Service Mcp Server
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.agentregistry.Service("default", {
 *     location: "us-central1",
 *     serviceId: "service",
 *     description: "My MCP agent registry service",
 *     displayName: "My Service",
 *     interfaces: [{
 *         url: "https://example.com",
 *         protocolBinding: "JSONRPC",
 *     }],
 *     mcpServerSpec: {
 *         type: "TOOL_SPEC",
 *         content: "{\"tools\":[]}",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * Service can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/services/{{service_id}}`
 * * `{{project}}/{{location}}/{{service_id}}`
 * * `{{location}}/{{service_id}}`
 *
 * When using the `pulumi import` command, Service can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:agentregistry/service:Service default projects/{{project}}/locations/{{location}}/services/{{service_id}}
 * $ pulumi import gcp:agentregistry/service:Service default {{project}}/{{location}}/{{service_id}}
 * $ pulumi import gcp:agentregistry/service:Service default {{location}}/{{service_id}}
 * ```
 */
export declare class Service extends pulumi.CustomResource {
    /**
     * Get an existing Service resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service;
    /**
     * Returns true if the given object is an instance of Service.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Service;
    /**
     * The spec of the Agent. When set, the type of the Service is Agent.
     * Structure is documented below.
     */
    readonly agentSpec: pulumi.Output<outputs.agentregistry.ServiceAgentSpec | undefined>;
    /**
     * The timestamp when the resource was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * The description of the Service.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * User-defined display name for the Service. Can have a maximum length of 63 characters.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * The spec of the Endpoint. When set, the type of the Service is Endpoint.
     * Structure is documented below.
     */
    readonly endpointSpec: pulumi.Output<outputs.agentregistry.ServiceEndpointSpec | undefined>;
    /**
     * The connection details for the Service.
     * Structure is documented below.
     */
    readonly interfaces: pulumi.Output<outputs.agentregistry.ServiceInterface[] | undefined>;
    /**
     * The location of the resource.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The spec of the MCP Server. When set, the type of the Service is MCP Server.
     * Structure is documented below.
     */
    readonly mcpServerSpec: pulumi.Output<outputs.agentregistry.ServiceMcpServerSpec | undefined>;
    /**
     * The resource name of the Service.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The resource name of the resulting Agent, MCP Server, or Endpoint.
     */
    readonly registryResource: pulumi.Output<string>;
    /**
     * The name of the Service.
     */
    readonly serviceId: pulumi.Output<string>;
    /**
     * The timestamp when the resource was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a Service resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Service resources.
 */
export interface ServiceState {
    /**
     * The spec of the Agent. When set, the type of the Service is Agent.
     * Structure is documented below.
     */
    agentSpec?: pulumi.Input<inputs.agentregistry.ServiceAgentSpec | undefined>;
    /**
     * The timestamp when the resource was created.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * The description of the Service.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User-defined display name for the Service. Can have a maximum length of 63 characters.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * The spec of the Endpoint. When set, the type of the Service is Endpoint.
     * Structure is documented below.
     */
    endpointSpec?: pulumi.Input<inputs.agentregistry.ServiceEndpointSpec | undefined>;
    /**
     * The connection details for the Service.
     * Structure is documented below.
     */
    interfaces?: pulumi.Input<pulumi.Input<inputs.agentregistry.ServiceInterface>[] | undefined>;
    /**
     * The location of the resource.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The spec of the MCP Server. When set, the type of the Service is MCP Server.
     * Structure is documented below.
     */
    mcpServerSpec?: pulumi.Input<inputs.agentregistry.ServiceMcpServerSpec | undefined>;
    /**
     * The resource name of the Service.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The resource name of the resulting Agent, MCP Server, or Endpoint.
     */
    registryResource?: pulumi.Input<string | undefined>;
    /**
     * The name of the Service.
     */
    serviceId?: pulumi.Input<string | undefined>;
    /**
     * The timestamp when the resource was updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Service resource.
 */
export interface ServiceArgs {
    /**
     * The spec of the Agent. When set, the type of the Service is Agent.
     * Structure is documented below.
     */
    agentSpec?: pulumi.Input<inputs.agentregistry.ServiceAgentSpec | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * The description of the Service.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User-defined display name for the Service. Can have a maximum length of 63 characters.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * The spec of the Endpoint. When set, the type of the Service is Endpoint.
     * Structure is documented below.
     */
    endpointSpec?: pulumi.Input<inputs.agentregistry.ServiceEndpointSpec | undefined>;
    /**
     * The connection details for the Service.
     * Structure is documented below.
     */
    interfaces?: pulumi.Input<pulumi.Input<inputs.agentregistry.ServiceInterface>[] | undefined>;
    /**
     * The location of the resource.
     */
    location: pulumi.Input<string>;
    /**
     * The spec of the MCP Server. When set, the type of the Service is MCP Server.
     * Structure is documented below.
     */
    mcpServerSpec?: pulumi.Input<inputs.agentregistry.ServiceMcpServerSpec | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The name of the Service.
     */
    serviceId: pulumi.Input<string>;
}
//# sourceMappingURL=service.d.ts.map