Package com.newrelic.api.agent

Class DatastoreParameters

java.lang.Object

com.newrelic.api.agent.DatastoreParameters

All Implemented Interfaces:

ExternalParameters

Direct Known Subclasses:

SlowQueryDatastoreParameters

public class DatastoreParameters
extends java.lang.Object
implements ExternalParameters

The input parameters required to report a datastore on the TracedMethod. 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	DatastoreParameters.Build
protected static class	DatastoreParameters.Builder
static interface	DatastoreParameters.CollectionParameter
static interface	DatastoreParameters.DatabaseParameter
static interface	DatastoreParameters.InstanceParameter
static interface	DatastoreParameters.OperationParameter
static interface	DatastoreParameters.SlowQueryParameter
static interface	DatastoreParameters.SlowQueryWithInputParameter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DatastoreParameters(DatastoreParameters datastoreParameters)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCloudResourceId()
java.lang.String	getCollection()	Returns the name of the collection or table.
java.lang.String	getDatabaseName()	Return the name of the database where the query was executed.
java.lang.String	getHost()	Returns the name of the host where the datastore is located.
java.lang.String	getOperation()	Returns the datastore operation.
java.lang.String	getPathOrId()	Return the path or id of the instance.
java.lang.Integer	getPort()	Returns the port for the connection to the datastore.
java.lang.String	getProduct()	Returns the name of the vendor.
static DatastoreParameters.CollectionParameter	product(java.lang.String product)	Set the name of the vendor.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatastoreParameters

protected DatastoreParameters(DatastoreParameters datastoreParameters)

Method Detail

getProduct

public java.lang.String getProduct()

Returns the name of the vendor.

Returns:

Vendor name

Since:

3.36.0

getCollection

public java.lang.String getCollection()

Returns the name of the collection or table.

Returns:

Table name

Since:

3.36.0

getOperation

public java.lang.String getOperation()

Returns the datastore operation. This is the primitive operation type accepted by the datastore itself or the name of the API method in the client library.

Returns:

Operation performed on the datastore

Since:

3.36.0

getHost

public java.lang.String getHost()

Returns the name of the host where the datastore is located.

Returns:

Host for the external call

Since:

3.36.0

getPort

public java.lang.Integer getPort()

Returns the port for the connection to the datastore.

Returns:

Port for the datastore

Since:

3.36.0

getPathOrId

public java.lang.String getPathOrId()

Return the path or id of the instance.

Returns:

Path or identifier of the datastore

getDatabaseName

public java.lang.String getDatabaseName()

Return the name of the database where the query was executed.

Returns:

Database name

getCloudResourceId

public java.lang.String getCloudResourceId()

Returns:

the cloud provider's identifier for the message queue. Eg. in AWS, this should be an ARN.

product

public static DatastoreParameters.CollectionParameter product(java.lang.String product)

Set the name of the vendor.

Parameters:

product - the name of the product

Returns:

the next builder interface