Package com.newrelic.api.agent

Class MessageConsumeParameters

java.lang.Object

com.newrelic.api.agent.MessageConsumeParameters

All Implemented Interfaces:

ExternalParameters

public class MessageConsumeParameters
extends java.lang.Object
implements ExternalParameters

Creates the parameters to report a message that was pulled from a message queue. This should be used with TracedMethod.reportAsExternal(ExternalParameters). A fluent builder is provided to allow for easy usage and management of this API.

Since:

3.36.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MessageConsumeParameters.Build
protected static class	MessageConsumeParameters.Builder
static interface	MessageConsumeParameters.DestinationNameParameter
static interface	MessageConsumeParameters.DestinationTypeParameter
static interface	MessageConsumeParameters.InboundHeadersParameter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageConsumeParameters(MessageConsumeParameters messageConsumeParameters)
protected	MessageConsumeParameters(java.lang.String library, DestinationType destinationType, java.lang.String destinationName, InboundHeaders inboundHeaders)	Deprecated.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCloudAccountId()
java.lang.String	getCloudRegion()
java.lang.String	getDestinationName()
DestinationType	getDestinationType()
java.lang.String	getHost()
InboundHeaders	getInboundHeaders()
java.lang.String	getLibrary()
java.lang.String	getOtelLibrary()
java.lang.Integer	getPort()
static MessageConsumeParameters.DestinationTypeParameter	library(java.lang.String library)	Set the name of the library.
static MessageConsumeParameters.DestinationTypeParameter	library(java.lang.String library, java.lang.String otelLibrary)	Set the name of the library.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageConsumeParameters

@Deprecated
protected MessageConsumeParameters(java.lang.String library,
                                   DestinationType destinationType,
                                   java.lang.String destinationName,
                                   InboundHeaders inboundHeaders)

Deprecated.

MessageConsumeParameters

protected MessageConsumeParameters(MessageConsumeParameters messageConsumeParameters)

Method Detail

getDestinationName

public java.lang.String getDestinationName()

getDestinationType

public DestinationType getDestinationType()

getInboundHeaders

public InboundHeaders getInboundHeaders()

getCloudAccountId

public java.lang.String getCloudAccountId()

getCloudRegion

public java.lang.String getCloudRegion()

getLibrary

public java.lang.String getLibrary()

getOtelLibrary

public java.lang.String getOtelLibrary()

getHost

public java.lang.String getHost()

getPort

public java.lang.Integer getPort()

library

public static MessageConsumeParameters.DestinationTypeParameter library(java.lang.String library)

Set the name of the library.

Parameters:

library - the name of the library

Returns:

the next builder interface

library

public static MessageConsumeParameters.DestinationTypeParameter library(java.lang.String library,
                                                                        java.lang.String otelLibrary)

Set the name of the library. And the OTEL known name of that library.

Parameters:

library - the name of the library

otelLibrary - the OTEL known name of the library

Returns:

the next builder interface