Package com.hashicorp.cdktf.providers.google.apigee_flowhook

Interface ApigeeFlowhookConfig

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

    • Method Detail

      • getEnvironment

        @Stability(Stable)
@NotNull
String getEnvironment()
        The resource ID of the environment.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_flowhook#environment ApigeeFlowhook#environment}

      • getFlowHookPoint

        @Stability(Stable)
@NotNull
String getFlowHookPoint()
        Where in the API call flow the flow hook is invoked.

        Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_flowhook#flow_hook_point ApigeeFlowhook#flow_hook_point}

      • getOrgId

        @Stability(Stable)
@NotNull
String getOrgId()
        The Apigee Organization associated with the environment.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_flowhook#org_id ApigeeFlowhook#org_id}

      • getSharedflow

        @Stability(Stable)
@NotNull
String getSharedflow()
        Id of the Sharedflow attaching to a flowhook point.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_flowhook#sharedflow ApigeeFlowhook#sharedflow}

      • getContinueOnError

        @Stability(Stable)
@Nullable
default Object getContinueOnError()
        Flag that specifies whether execution should continue if the flow hook throws an exception.

        Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_flowhook#continue_on_error ApigeeFlowhook#continue_on_error}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        Description of the flow hook.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_flowhook#description ApigeeFlowhook#description}

      • getId

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

      • getTimeouts

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

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