Package com.oracle.bmc.objectstorage.model

Class PreauthenticatedRequest

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.objectstorage.model.PreauthenticatedRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class PreauthenticatedRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Pre-authenticated requests provide a way to let users access a bucket or an object without having their own credentials.

When you create a pre-authenticated request, a unique URL is generated. Users in your organization, partners, or third parties can use this URL to access the targets identified in the pre-authenticated request. See Using Pre-Authenticated Requests.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the PreauthenticatedRequest.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 PreauthenticatedRequest.Builder, which maintain a set of all explicitly set fields called PreauthenticatedRequest.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreauthenticatedRequest.AccessType	The operation that can be performed on this resource.
static class	PreauthenticatedRequest.BucketListingAction	Specifies whether a list operation is allowed on a PAR with accessType “AnyObjectRead” or “AnyObjectReadWrite”.
static class	PreauthenticatedRequest.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
PreauthenticatedRequest(String id, String name, String accessUri, String objectName, PreauthenticatedRequest.BucketListingAction bucketListingAction, PreauthenticatedRequest.AccessType accessType, Date timeExpires, Date timeCreated, String fullPath)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static PreauthenticatedRequest.Builder	builder()	Create a new builder.
boolean	equals(Object o)
PreauthenticatedRequest.AccessType	getAccessType()	The operation that can be performed on this resource.
String	getAccessUri()	The URI to embed in the URL when using the pre-authenticated request.
PreauthenticatedRequest.BucketListingAction	getBucketListingAction()	Specifies whether a list operation is allowed on a PAR with accessType “AnyObjectRead” or “AnyObjectReadWrite”.
String	getFullPath()	The full Path for the object.
String	getId()	The unique identifier to use when directly addressing the pre-authenticated request.
String	getName()	The user-provided name of the pre-authenticated request.
String	getObjectName()	The name of the object that is being granted access to by the pre-authenticated request.
Date	getTimeCreated()	The date when the pre-authenticated request was created as per specification RFC 3339.
Date	getTimeExpires()	The expiration date for the pre-authenticated request as per RFC 3339.
int	hashCode()
PreauthenticatedRequest.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

PreauthenticatedRequest

@Deprecated
@ConstructorProperties({"id","name","accessUri","objectName","bucketListingAction","accessType","timeExpires","timeCreated","fullPath"})
public PreauthenticatedRequest(String id,
                               String name,
                               String accessUri,
                               String objectName,
                               PreauthenticatedRequest.BucketListingAction bucketListingAction,
                               PreauthenticatedRequest.AccessType accessType,
                               Date timeExpires,
                               Date timeCreated,
                               String fullPath)

Deprecated.

Method Detail

builder

public static PreauthenticatedRequest.Builder builder()

Create a new builder.

toBuilder

public PreauthenticatedRequest.Builder toBuilder()

getId

public String getId()

The unique identifier to use when directly addressing the pre-authenticated request.

Returns:

the value

getName

public String getName()

The user-provided name of the pre-authenticated request.

Returns:

the value

getAccessUri

public String getAccessUri()

The URI to embed in the URL when using the pre-authenticated request.

Returns:

the value

getObjectName

public String getObjectName()

The name of the object that is being granted access to by the pre-authenticated request.

Avoid entering confidential information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket. Example: test/object1.log

Returns:

the value

getBucketListingAction

public PreauthenticatedRequest.BucketListingAction getBucketListingAction()

Specifies whether a list operation is allowed on a PAR with accessType “AnyObjectRead” or “AnyObjectReadWrite”.

Deny: Prevents the user from performing a list operation. ListObjects: Authorizes the user to perform a list operation.

Returns:

the value

getAccessType

public PreauthenticatedRequest.AccessType getAccessType()

The operation that can be performed on this resource.

Returns:

the value

getTimeExpires

public Date getTimeExpires()

The expiration date for the pre-authenticated request as per RFC 3339.

After this date the pre-authenticated request will no longer be valid.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date when the pre-authenticated request was created as per specification RFC 3339.

Returns:

the value

getFullPath

public String getFullPath()

The full Path for the object.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.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 com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel