Package com.hashicorp.cdktf.providers.google.endpoints_service

Interface EndpointsServiceConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    EndpointsServiceConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.153Z")
@Stability(Stable)
public interface EndpointsServiceConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getServiceName

        @Stability(Stable)
@NotNull
String getServiceName()
        The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/endpoints_service#service_name EndpointsService#service_name}

      • getGrpcConfig

        @Stability(Stable)
@Nullable
default String getGrpcConfig()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/endpoints_service#grpc_config EndpointsService#grpc_config}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/endpoints_service#id EndpointsService#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getOpenapiConfig

        @Stability(Stable)
@Nullable
default String getOpenapiConfig()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/endpoints_service#openapi_config EndpointsService#openapi_config}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        The project ID that the service belongs to. If not provided, provider project is used.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/endpoints_service#project EndpointsService#project}

      • getProtocOutputBase64

        @Stability(Stable)
@Nullable
default String getProtocOutputBase64()
        The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/endpoints_service#protoc_output_base64 EndpointsService#protoc_output_base64}

      • getTimeouts

        @Stability(Stable)
@Nullable
default EndpointsServiceTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/endpoints_service#timeouts EndpointsService#timeouts}