Google Cloud Native v0.30.0, Apr 14 23

google-native.apigee/v1.getDebugSession

Explore with Pulumi AI

Retrieves a debug session.

Using getDebugSession

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 getDebugSession(args: GetDebugSessionArgs, opts?: InvokeOptions): Promise<GetDebugSessionResult>
function getDebugSessionOutput(args: GetDebugSessionOutputArgs, opts?: InvokeOptions): Output<GetDebugSessionResult>

def get_debug_session(api_id: Optional[str] = None,
                      debugsession_id: Optional[str] = None,
                      environment_id: Optional[str] = None,
                      organization_id: Optional[str] = None,
                      revision_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDebugSessionResult
def get_debug_session_output(api_id: Optional[pulumi.Input[str]] = None,
                      debugsession_id: Optional[pulumi.Input[str]] = None,
                      environment_id: Optional[pulumi.Input[str]] = None,
                      organization_id: Optional[pulumi.Input[str]] = None,
                      revision_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDebugSessionResult]

func LookupDebugSession(ctx *Context, args *LookupDebugSessionArgs, opts ...InvokeOption) (*LookupDebugSessionResult, error)
func LookupDebugSessionOutput(ctx *Context, args *LookupDebugSessionOutputArgs, opts ...InvokeOption) LookupDebugSessionResultOutput

> Note: This function is named LookupDebugSession in the Go SDK.

public static class GetDebugSession 
{
    public static Task<GetDebugSessionResult> InvokeAsync(GetDebugSessionArgs args, InvokeOptions? opts = null)
    public static Output<GetDebugSessionResult> Invoke(GetDebugSessionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDebugSessionResult> getDebugSession(GetDebugSessionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:apigee/v1:getDebugSession
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiId string
DebugsessionId string
EnvironmentId string
OrganizationId string
RevisionId string

ApiId string
DebugsessionId string
EnvironmentId string
OrganizationId string
RevisionId string

apiId String
debugsessionId String
environmentId String
organizationId String
revisionId String

apiId string
debugsessionId string
environmentId string
organizationId string
revisionId string

api_id str
debugsession_id str
environment_id str
organization_id str
revision_id str

apiId String
debugsessionId String
environmentId String
organizationId String
revisionId String

getDebugSession Result

The following output properties are available:

Count int: Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
CreateTime string: The first transaction creation timestamp, recorded by UAP.
Filter string: Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
Name string: A unique ID for this DebugSession.
Timeout string: Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
Tracesize int: Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
Validity int: Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

Count int: Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
CreateTime string: The first transaction creation timestamp, recorded by UAP.
Filter string: Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
Name string: A unique ID for this DebugSession.
Timeout string: Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
Tracesize int: Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
Validity int: Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

count Integer: Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
createTime String: The first transaction creation timestamp, recorded by UAP.
filter String: Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
name String: A unique ID for this DebugSession.
timeout String: Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
tracesize Integer: Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
validity Integer: Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

count number: Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
createTime string: The first transaction creation timestamp, recorded by UAP.
filter string: Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
name string: A unique ID for this DebugSession.
timeout string: Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
tracesize number: Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
validity number: Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

count int: Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
create_time str: The first transaction creation timestamp, recorded by UAP.
filter str: Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
name str: A unique ID for this DebugSession.
timeout str: Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
tracesize int: Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
validity int: Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

count Number: Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
createTime String: The first transaction creation timestamp, recorded by UAP.
filter String: Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
name String: A unique ID for this DebugSession.
timeout String: Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
tracesize Number: Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
validity Number: Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

google-native.apigee/v1.getDebugSession

Using getDebugSession

getDebugSession Result

Package Details

On this page

On this page