1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. endpoints
  5. Service
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.endpoints.Service

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    This resource creates and rolls out a Cloud Endpoints service using OpenAPI or gRPC. View the relevant docs for OpenAPI and gRPC.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    import * as std from "@pulumi/std";
    
    const openapiService = new gcp.endpoints.Service("openapi_service", {
        serviceName: "api-name.endpoints.project-id.cloud.goog",
        project: "project-id",
        openapiConfig: std.file({
            input: "openapi_spec.yml",
        }).then(invoke => invoke.result),
    });
    const grpcService = new gcp.endpoints.Service("grpc_service", {
        serviceName: "api-name.endpoints.project-id.cloud.goog",
        project: "project-id",
        grpcConfig: std.file({
            input: "service_spec.yml",
        }).then(invoke => invoke.result),
        protocOutputBase64: std.filebase64({
            input: "compiled_descriptor_file.pb",
        }).then(invoke => invoke.result),
    });
    
    import pulumi
    import pulumi_gcp as gcp
    import pulumi_std as std
    
    openapi_service = gcp.endpoints.Service("openapi_service",
        service_name="api-name.endpoints.project-id.cloud.goog",
        project="project-id",
        openapi_config=std.file(input="openapi_spec.yml").result)
    grpc_service = gcp.endpoints.Service("grpc_service",
        service_name="api-name.endpoints.project-id.cloud.goog",
        project="project-id",
        grpc_config=std.file(input="service_spec.yml").result,
        protoc_output_base64=std.filebase64(input="compiled_descriptor_file.pb").result)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/endpoints"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokeFile, err := std.File(ctx, &std.FileArgs{
    			Input: "openapi_spec.yml",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = endpoints.NewService(ctx, "openapi_service", &endpoints.ServiceArgs{
    			ServiceName:   pulumi.String("api-name.endpoints.project-id.cloud.goog"),
    			Project:       pulumi.String("project-id"),
    			OpenapiConfig: invokeFile.Result,
    		})
    		if err != nil {
    			return err
    		}
    		invokeFile1, err := std.File(ctx, &std.FileArgs{
    			Input: "service_spec.yml",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		invokeFilebase642, err := std.Filebase64(ctx, &std.Filebase64Args{
    			Input: "compiled_descriptor_file.pb",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = endpoints.NewService(ctx, "grpc_service", &endpoints.ServiceArgs{
    			ServiceName:        pulumi.String("api-name.endpoints.project-id.cloud.goog"),
    			Project:            pulumi.String("project-id"),
    			GrpcConfig:         invokeFile1.Result,
    			ProtocOutputBase64: invokeFilebase642.Result,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var openapiService = new Gcp.Endpoints.Service("openapi_service", new()
        {
            ServiceName = "api-name.endpoints.project-id.cloud.goog",
            Project = "project-id",
            OpenapiConfig = Std.File.Invoke(new()
            {
                Input = "openapi_spec.yml",
            }).Apply(invoke => invoke.Result),
        });
    
        var grpcService = new Gcp.Endpoints.Service("grpc_service", new()
        {
            ServiceName = "api-name.endpoints.project-id.cloud.goog",
            Project = "project-id",
            GrpcConfig = Std.File.Invoke(new()
            {
                Input = "service_spec.yml",
            }).Apply(invoke => invoke.Result),
            ProtocOutputBase64 = Std.Filebase64.Invoke(new()
            {
                Input = "compiled_descriptor_file.pb",
            }).Apply(invoke => invoke.Result),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.endpoints.Service;
    import com.pulumi.gcp.endpoints.ServiceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var openapiService = new Service("openapiService", ServiceArgs.builder()
                .serviceName("api-name.endpoints.project-id.cloud.goog")
                .project("project-id")
                .openapiConfig(StdFunctions.file(FileArgs.builder()
                    .input("openapi_spec.yml")
                    .build()).result())
                .build());
    
            var grpcService = new Service("grpcService", ServiceArgs.builder()
                .serviceName("api-name.endpoints.project-id.cloud.goog")
                .project("project-id")
                .grpcConfig(StdFunctions.file(FileArgs.builder()
                    .input("service_spec.yml")
                    .build()).result())
                .protocOutputBase64(StdFunctions.filebase64(Filebase64Args.builder()
                    .input("compiled_descriptor_file.pb")
                    .build()).result())
                .build());
    
        }
    }
    
    resources:
      openapiService:
        type: gcp:endpoints:Service
        name: openapi_service
        properties:
          serviceName: api-name.endpoints.project-id.cloud.goog
          project: project-id
          openapiConfig:
            fn::invoke:
              Function: std:file
              Arguments:
                input: openapi_spec.yml
              Return: result
      grpcService:
        type: gcp:endpoints:Service
        name: grpc_service
        properties:
          serviceName: api-name.endpoints.project-id.cloud.goog
          project: project-id
          grpcConfig:
            fn::invoke:
              Function: std:file
              Arguments:
                input: service_spec.yml
              Return: result
          protocOutputBase64:
            fn::invoke:
              Function: std:filebase64
              Arguments:
                input: compiled_descriptor_file.pb
              Return: result
    

    The example in examples/endpoints_on_compute_engine shows the API from the quickstart running on a Compute Engine VM and reachable through Cloud Endpoints, which may also be useful.

    Create Service Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
    def Service(resource_name: str,
                args: ServiceArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Service(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                service_name: Optional[str] = None,
                grpc_config: Optional[str] = None,
                openapi_config: Optional[str] = None,
                project: Optional[str] = None,
                protoc_output_base64: Optional[str] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
    public Service(String name, ServiceArgs args, CustomResourceOptions options)
    
    type: gcp:endpoints:Service
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleserviceResourceResourceFromEndpointsservice = new Gcp.Endpoints.Service("exampleserviceResourceResourceFromEndpointsservice", new()
    {
        ServiceName = "string",
        GrpcConfig = "string",
        OpenapiConfig = "string",
        Project = "string",
        ProtocOutputBase64 = "string",
    });
    
    example, err := endpoints.NewService(ctx, "exampleserviceResourceResourceFromEndpointsservice", &endpoints.ServiceArgs{
    	ServiceName:        pulumi.String("string"),
    	GrpcConfig:         pulumi.String("string"),
    	OpenapiConfig:      pulumi.String("string"),
    	Project:            pulumi.String("string"),
    	ProtocOutputBase64: pulumi.String("string"),
    })
    
    var exampleserviceResourceResourceFromEndpointsservice = new Service("exampleserviceResourceResourceFromEndpointsservice", ServiceArgs.builder()
        .serviceName("string")
        .grpcConfig("string")
        .openapiConfig("string")
        .project("string")
        .protocOutputBase64("string")
        .build());
    
    exampleservice_resource_resource_from_endpointsservice = gcp.endpoints.Service("exampleserviceResourceResourceFromEndpointsservice",
        service_name="string",
        grpc_config="string",
        openapi_config="string",
        project="string",
        protoc_output_base64="string")
    
    const exampleserviceResourceResourceFromEndpointsservice = new gcp.endpoints.Service("exampleserviceResourceResourceFromEndpointsservice", {
        serviceName: "string",
        grpcConfig: "string",
        openapiConfig: "string",
        project: "string",
        protocOutputBase64: "string",
    });
    
    type: gcp:endpoints:Service
    properties:
        grpcConfig: string
        openapiConfig: string
        project: string
        protocOutputBase64: string
        serviceName: string
    

    Service Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Service resource accepts the following input properties:

    ServiceName string
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    GrpcConfig string
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    OpenapiConfig string
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    Project string
    The project ID that the service belongs to. If not provided, provider project is used.
    ProtocOutputBase64 string
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    ServiceName string
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    GrpcConfig string
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    OpenapiConfig string
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    Project string
    The project ID that the service belongs to. If not provided, provider project is used.
    ProtocOutputBase64 string
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    serviceName String
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    grpcConfig String
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapiConfig String
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project String
    The project ID that the service belongs to. If not provided, provider project is used.
    protocOutputBase64 String
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    serviceName string
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    grpcConfig string
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapiConfig string
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project string
    The project ID that the service belongs to. If not provided, provider project is used.
    protocOutputBase64 string
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    service_name str
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    grpc_config str
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapi_config str
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project str
    The project ID that the service belongs to. If not provided, provider project is used.
    protoc_output_base64 str
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    serviceName String
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    grpcConfig String
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapiConfig String
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project String
    The project ID that the service belongs to. If not provided, provider project is used.
    protocOutputBase64 String
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

    Apis List<ServiceApi>
    A list of API objects; structure is documented below.
    ConfigId string
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    DnsAddress string
    The address at which the service can be found - usually the same as the service name.
    Endpoints List<ServiceEndpoint>
    A list of Endpoint objects; structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Apis []ServiceApi
    A list of API objects; structure is documented below.
    ConfigId string
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    DnsAddress string
    The address at which the service can be found - usually the same as the service name.
    Endpoints []ServiceEndpoint
    A list of Endpoint objects; structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    apis List<ServiceApi>
    A list of API objects; structure is documented below.
    configId String
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dnsAddress String
    The address at which the service can be found - usually the same as the service name.
    endpoints List<ServiceEndpoint>
    A list of Endpoint objects; structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    apis ServiceApi[]
    A list of API objects; structure is documented below.
    configId string
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dnsAddress string
    The address at which the service can be found - usually the same as the service name.
    endpoints ServiceEndpoint[]
    A list of Endpoint objects; structure is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    apis Sequence[ServiceApi]
    A list of API objects; structure is documented below.
    config_id str
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dns_address str
    The address at which the service can be found - usually the same as the service name.
    endpoints Sequence[ServiceEndpoint]
    A list of Endpoint objects; structure is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    apis List<Property Map>
    A list of API objects; structure is documented below.
    configId String
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dnsAddress String
    The address at which the service can be found - usually the same as the service name.
    endpoints List<Property Map>
    A list of Endpoint objects; structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Service Resource

    Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apis: Optional[Sequence[ServiceApiArgs]] = None,
            config_id: Optional[str] = None,
            dns_address: Optional[str] = None,
            endpoints: Optional[Sequence[ServiceEndpointArgs]] = None,
            grpc_config: Optional[str] = None,
            openapi_config: Optional[str] = None,
            project: Optional[str] = None,
            protoc_output_base64: Optional[str] = None,
            service_name: Optional[str] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Apis List<ServiceApi>
    A list of API objects; structure is documented below.
    ConfigId string
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    DnsAddress string
    The address at which the service can be found - usually the same as the service name.
    Endpoints List<ServiceEndpoint>
    A list of Endpoint objects; structure is documented below.
    GrpcConfig string
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    OpenapiConfig string
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    Project string
    The project ID that the service belongs to. If not provided, provider project is used.
    ProtocOutputBase64 string
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    ServiceName string
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    Apis []ServiceApiArgs
    A list of API objects; structure is documented below.
    ConfigId string
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    DnsAddress string
    The address at which the service can be found - usually the same as the service name.
    Endpoints []ServiceEndpointArgs
    A list of Endpoint objects; structure is documented below.
    GrpcConfig string
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    OpenapiConfig string
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    Project string
    The project ID that the service belongs to. If not provided, provider project is used.
    ProtocOutputBase64 string
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    ServiceName string
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    apis List<ServiceApi>
    A list of API objects; structure is documented below.
    configId String
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dnsAddress String
    The address at which the service can be found - usually the same as the service name.
    endpoints List<ServiceEndpoint>
    A list of Endpoint objects; structure is documented below.
    grpcConfig String
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapiConfig String
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project String
    The project ID that the service belongs to. If not provided, provider project is used.
    protocOutputBase64 String
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    serviceName String
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    apis ServiceApi[]
    A list of API objects; structure is documented below.
    configId string
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dnsAddress string
    The address at which the service can be found - usually the same as the service name.
    endpoints ServiceEndpoint[]
    A list of Endpoint objects; structure is documented below.
    grpcConfig string
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapiConfig string
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project string
    The project ID that the service belongs to. If not provided, provider project is used.
    protocOutputBase64 string
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    serviceName string
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    apis Sequence[ServiceApiArgs]
    A list of API objects; structure is documented below.
    config_id str
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dns_address str
    The address at which the service can be found - usually the same as the service name.
    endpoints Sequence[ServiceEndpointArgs]
    A list of Endpoint objects; structure is documented below.
    grpc_config str
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapi_config str
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project str
    The project ID that the service belongs to. If not provided, provider project is used.
    protoc_output_base64 str
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    service_name str
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    apis List<Property Map>
    A list of API objects; structure is documented below.
    configId String
    The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
    dnsAddress String
    The address at which the service can be found - usually the same as the service name.
    endpoints List<Property Map>
    A list of Endpoint objects; structure is documented below.
    grpcConfig String
    The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
    openapiConfig String
    The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
    project String
    The project ID that the service belongs to. If not provided, provider project is used.
    protocOutputBase64 String
    The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
    serviceName String
    The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.


    Supporting Types

    ServiceApi, ServiceApiArgs

    Methods List<ServiceApiMethod>
    A list of Method objects; structure is documented below.
    Name string
    The simple name of the endpoint as described in the config.
    Syntax string
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    Version string
    A version string for this api. If specified, will have the form major-version.minor-version, e.g. 1.10.
    Methods []ServiceApiMethod
    A list of Method objects; structure is documented below.
    Name string
    The simple name of the endpoint as described in the config.
    Syntax string
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    Version string
    A version string for this api. If specified, will have the form major-version.minor-version, e.g. 1.10.
    methods List<ServiceApiMethod>
    A list of Method objects; structure is documented below.
    name String
    The simple name of the endpoint as described in the config.
    syntax String
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    version String
    A version string for this api. If specified, will have the form major-version.minor-version, e.g. 1.10.
    methods ServiceApiMethod[]
    A list of Method objects; structure is documented below.
    name string
    The simple name of the endpoint as described in the config.
    syntax string
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    version string
    A version string for this api. If specified, will have the form major-version.minor-version, e.g. 1.10.
    methods Sequence[ServiceApiMethod]
    A list of Method objects; structure is documented below.
    name str
    The simple name of the endpoint as described in the config.
    syntax str
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    version str
    A version string for this api. If specified, will have the form major-version.minor-version, e.g. 1.10.
    methods List<Property Map>
    A list of Method objects; structure is documented below.
    name String
    The simple name of the endpoint as described in the config.
    syntax String
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    version String
    A version string for this api. If specified, will have the form major-version.minor-version, e.g. 1.10.

    ServiceApiMethod, ServiceApiMethodArgs

    Name string
    The simple name of the endpoint as described in the config.
    RequestType string
    The type URL for the request to this API.
    ResponseType string
    The type URL for the response from this API.
    Syntax string
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    Name string
    The simple name of the endpoint as described in the config.
    RequestType string
    The type URL for the request to this API.
    ResponseType string
    The type URL for the response from this API.
    Syntax string
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    name String
    The simple name of the endpoint as described in the config.
    requestType String
    The type URL for the request to this API.
    responseType String
    The type URL for the response from this API.
    syntax String
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    name string
    The simple name of the endpoint as described in the config.
    requestType string
    The type URL for the request to this API.
    responseType string
    The type URL for the response from this API.
    syntax string
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    name str
    The simple name of the endpoint as described in the config.
    request_type str
    The type URL for the request to this API.
    response_type str
    The type URL for the response from this API.
    syntax str
    SYNTAX_PROTO2 or SYNTAX_PROTO3.
    name String
    The simple name of the endpoint as described in the config.
    requestType String
    The type URL for the request to this API.
    responseType String
    The type URL for the response from this API.
    syntax String
    SYNTAX_PROTO2 or SYNTAX_PROTO3.

    ServiceEndpoint, ServiceEndpointArgs

    Address string
    The FQDN of the endpoint as described in the config.
    Name string
    The simple name of the endpoint as described in the config.
    Address string
    The FQDN of the endpoint as described in the config.
    Name string
    The simple name of the endpoint as described in the config.
    address String
    The FQDN of the endpoint as described in the config.
    name String
    The simple name of the endpoint as described in the config.
    address string
    The FQDN of the endpoint as described in the config.
    name string
    The simple name of the endpoint as described in the config.
    address str
    The FQDN of the endpoint as described in the config.
    name str
    The simple name of the endpoint as described in the config.
    address String
    The FQDN of the endpoint as described in the config.
    name String
    The simple name of the endpoint as described in the config.

    Import

    This resource does not support import.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi