konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
konnect.getGatewayPluginMocking
Explore with Pulumi AI
Using getGatewayPluginMocking
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGatewayPluginMocking(args: GetGatewayPluginMockingArgs, opts?: InvokeOptions): Promise<GetGatewayPluginMockingResult>
function getGatewayPluginMockingOutput(args: GetGatewayPluginMockingOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginMockingResult>def get_gateway_plugin_mocking(control_plane_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetGatewayPluginMockingResult
def get_gateway_plugin_mocking_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginMockingResult]func LookupGatewayPluginMocking(ctx *Context, args *LookupGatewayPluginMockingArgs, opts ...InvokeOption) (*LookupGatewayPluginMockingResult, error)
func LookupGatewayPluginMockingOutput(ctx *Context, args *LookupGatewayPluginMockingOutputArgs, opts ...InvokeOption) LookupGatewayPluginMockingResultOutput> Note: This function is named LookupGatewayPluginMocking in the Go SDK.
public static class GetGatewayPluginMocking 
{
    public static Task<GetGatewayPluginMockingResult> InvokeAsync(GetGatewayPluginMockingArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginMockingResult> Invoke(GetGatewayPluginMockingInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGatewayPluginMockingResult> getGatewayPluginMocking(GetGatewayPluginMockingArgs args, InvokeOptions options)
public static Output<GetGatewayPluginMockingResult> getGatewayPluginMocking(GetGatewayPluginMockingArgs args, InvokeOptions options)
fn::invoke:
  function: konnect:index/getGatewayPluginMocking:getGatewayPluginMocking
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ControlPlane stringId 
- ControlPlane stringId 
- controlPlane StringId 
- controlPlane stringId 
- control_plane_ strid 
- controlPlane StringId 
getGatewayPluginMocking Result
The following output properties are available:
- Config
GetGateway Plugin Mocking Config 
- Consumer
GetGateway Plugin Mocking Consumer 
- ControlPlane stringId 
- CreatedAt double
- Enabled bool
- Id string
- InstanceName string
- Ordering
GetGateway Plugin Mocking Ordering 
- Protocols List<string>
- Route
GetGateway Plugin Mocking Route 
- Service
GetGateway Plugin Mocking Service 
- List<string>
- UpdatedAt double
- Config
GetGateway Plugin Mocking Config 
- Consumer
GetGateway Plugin Mocking Consumer 
- ControlPlane stringId 
- CreatedAt float64
- Enabled bool
- Id string
- InstanceName string
- Ordering
GetGateway Plugin Mocking Ordering 
- Protocols []string
- Route
GetGateway Plugin Mocking Route 
- Service
GetGateway Plugin Mocking Service 
- []string
- UpdatedAt float64
- config
GetGateway Plugin Mocking Config 
- consumer
GetGateway Plugin Mocking Consumer 
- controlPlane StringId 
- createdAt Double
- enabled Boolean
- id String
- instanceName String
- ordering
GetGateway Plugin Mocking Ordering 
- protocols List<String>
- route
GetGateway Plugin Mocking Route 
- service
GetGateway Plugin Mocking Service 
- List<String>
- updatedAt Double
- config
GetGateway Plugin Mocking Config 
- consumer
GetGateway Plugin Mocking Consumer 
- controlPlane stringId 
- createdAt number
- enabled boolean
- id string
- instanceName string
- ordering
GetGateway Plugin Mocking Ordering 
- protocols string[]
- route
GetGateway Plugin Mocking Route 
- service
GetGateway Plugin Mocking Service 
- string[]
- updatedAt number
- config
GetGateway Plugin Mocking Config 
- consumer
GetGateway Plugin Mocking Consumer 
- control_plane_ strid 
- created_at float
- enabled bool
- id str
- instance_name str
- ordering
GetGateway Plugin Mocking Ordering 
- protocols Sequence[str]
- route
GetGateway Plugin Mocking Route 
- service
GetGateway Plugin Mocking Service 
- Sequence[str]
- updated_at float
- config Property Map
- consumer Property Map
- controlPlane StringId 
- createdAt Number
- enabled Boolean
- id String
- instanceName String
- ordering Property Map
- protocols List<String>
- route Property Map
- service Property Map
- List<String>
- updatedAt Number
Supporting Types
GetGatewayPluginMockingConfig    
- ApiSpecification string
- The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the Config.Api Specificationtext field.
- ApiSpecification stringFilename 
- The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode.
- CustomBase stringPath 
- The base path to be used for path match evaluation. This value is ignored if include_base_pathis set tofalse.
- IncludeBase boolPath 
- Indicates whether to include the base path when performing path match evaluation.
- IncludedStatus List<double>Codes 
- A global list of the HTTP status codes that can only be selected and returned.
- MaxDelay doubleTime 
- The maximum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be greater than themin_delay_time.
- MinDelay doubleTime 
- The minimum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be less than themax_delay_time.
- RandomDelay bool
- Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs.
- RandomExamples bool
- Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured.
- RandomStatus boolCode 
- Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is false, which means the minimum HTTP status code is always selected and returned.
- ApiSpecification string
- The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the Config.Api Specificationtext field.
- ApiSpecification stringFilename 
- The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode.
- CustomBase stringPath 
- The base path to be used for path match evaluation. This value is ignored if include_base_pathis set tofalse.
- IncludeBase boolPath 
- Indicates whether to include the base path when performing path match evaluation.
- IncludedStatus []float64Codes 
- A global list of the HTTP status codes that can only be selected and returned.
- MaxDelay float64Time 
- The maximum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be greater than themin_delay_time.
- MinDelay float64Time 
- The minimum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be less than themax_delay_time.
- RandomDelay bool
- Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs.
- RandomExamples bool
- Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured.
- RandomStatus boolCode 
- Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is false, which means the minimum HTTP status code is always selected and returned.
- apiSpecification String
- The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the Config.Api Specificationtext field.
- apiSpecification StringFilename 
- The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode.
- customBase StringPath 
- The base path to be used for path match evaluation. This value is ignored if include_base_pathis set tofalse.
- includeBase BooleanPath 
- Indicates whether to include the base path when performing path match evaluation.
- includedStatus List<Double>Codes 
- A global list of the HTTP status codes that can only be selected and returned.
- maxDelay DoubleTime 
- The maximum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be greater than themin_delay_time.
- minDelay DoubleTime 
- The minimum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be less than themax_delay_time.
- randomDelay Boolean
- Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs.
- randomExamples Boolean
- Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured.
- randomStatus BooleanCode 
- Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is false, which means the minimum HTTP status code is always selected and returned.
- apiSpecification string
- The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the Config.Api Specificationtext field.
- apiSpecification stringFilename 
- The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode.
- customBase stringPath 
- The base path to be used for path match evaluation. This value is ignored if include_base_pathis set tofalse.
- includeBase booleanPath 
- Indicates whether to include the base path when performing path match evaluation.
- includedStatus number[]Codes 
- A global list of the HTTP status codes that can only be selected and returned.
- maxDelay numberTime 
- The maximum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be greater than themin_delay_time.
- minDelay numberTime 
- The minimum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be less than themax_delay_time.
- randomDelay boolean
- Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs.
- randomExamples boolean
- Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured.
- randomStatus booleanCode 
- Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is false, which means the minimum HTTP status code is always selected and returned.
- api_specification str
- The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the Config.Api Specificationtext field.
- api_specification_ strfilename 
- The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode.
- custom_base_ strpath 
- The base path to be used for path match evaluation. This value is ignored if include_base_pathis set tofalse.
- include_base_ boolpath 
- Indicates whether to include the base path when performing path match evaluation.
- included_status_ Sequence[float]codes 
- A global list of the HTTP status codes that can only be selected and returned.
- max_delay_ floattime 
- The maximum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be greater than themin_delay_time.
- min_delay_ floattime 
- The minimum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be less than themax_delay_time.
- random_delay bool
- Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs.
- random_examples bool
- Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured.
- random_status_ boolcode 
- Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is false, which means the minimum HTTP status code is always selected and returned.
- apiSpecification String
- The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the Config.Api Specificationtext field.
- apiSpecification StringFilename 
- The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode.
- customBase StringPath 
- The base path to be used for path match evaluation. This value is ignored if include_base_pathis set tofalse.
- includeBase BooleanPath 
- Indicates whether to include the base path when performing path match evaluation.
- includedStatus List<Number>Codes 
- A global list of the HTTP status codes that can only be selected and returned.
- maxDelay NumberTime 
- The maximum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be greater than themin_delay_time.
- minDelay NumberTime 
- The minimum value in seconds of delay time. Set this value when random_delayis enabled and you want to adjust the default. The value must be less than themax_delay_time.
- randomDelay Boolean
- Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs.
- randomExamples Boolean
- Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured.
- randomStatus BooleanCode 
- Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is false, which means the minimum HTTP status code is always selected and returned.
GetGatewayPluginMockingConsumer    
- Id string
- Id string
- id String
- id string
- id str
- id String
GetGatewayPluginMockingOrdering    
GetGatewayPluginMockingOrderingAfter     
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GetGatewayPluginMockingOrderingBefore     
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GetGatewayPluginMockingRoute    
- Id string
- Id string
- id String
- id string
- id str
- id String
GetGatewayPluginMockingService    
- Id string
- Id string
- id String
- id string
- id str
- id String
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the konnectTerraform Provider.