com.oracle.bmc.audit.model

Class Response

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.audit.model.Response

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190901")
public final class Response
extends ExplicitlySetBmcModel

A container object for response attributes.

Note: Objects should always be created or deserialized using the Response.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Response.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Response.Builder

Constructor Summary

Constructors

Constructor and Description
Response(String status, Date responseTime, Map<String,List<String>> headers, Map<String,Object> payload, String message) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Response.Builder	builder() Create a new builder.
boolean	equals(Object o)
Map<String,List<String>>	getHeaders() The headers of the response.
String	getMessage() A friendly description of what happened during the operation.
Map<String,Object>	getPayload() This value is included for backward compatibility with the Audit version 1 schema, where it contained metadata of interest from the response payload.
Date	getResponseTime() The time of the response to the audited request, expressed in RFC 3339 timestamp format.
String	getStatus() The status code of the response.
int	hashCode()
Response.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Response

@Deprecated
 @ConstructorProperties(value={"status","responseTime","headers","payload","message"})
public Response(String status,
                                                                                                                   Date responseTime,
                                                                                                                   Map<String,List<String>> headers,
                                                                                                                   Map<String,Object> payload,
                                                                                                                   String message)

Deprecated.

Method Detail

builder

public static Response.Builder builder()

Create a new builder.

toBuilder

public Response.Builder toBuilder()

getStatus

public String getStatus()

The status code of the response.

Example: 200

Returns:

the value

getResponseTime

public Date getResponseTime()

The time of the response to the audited request, expressed in RFC 3339 timestamp format.

Example: 2019-09-18T00:10:59.278Z

Returns:

the value

getHeaders

public Map<String,List<String>> getHeaders()

The headers of the response.

Example:

----- { "ETag": [ "" ], "Connection": [ "close" ], "Content-Length": [ "1828" ], "opc-request-id": [ "" ], "Date": [ "Wed, 18 Sep 2019 00:10:59 GMT" ], "Content-Type": [ "application/json" ] } -----

Returns:

the value

getPayload

public Map<String,Object> getPayload()

This value is included for backward compatibility with the Audit version 1 schema, where it contained metadata of interest from the response payload.

Example:

----- { "resourceName": "my_instance", "id": "ocid1.instance.oc1.phx." } -----

Returns:

the value

getMessage

public String getMessage()

A friendly description of what happened during the operation. Use this for troubleshooting.

Returns:

the value

toString

public String toString()

Overrides:

toString in class ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel