Class GetObjectRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.objectstorage.requests.GetObjectRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class GetObjectRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/objectstorage/GetObjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetObjectRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetObjectRequest.Builder
-
Constructor Summary
Constructors Constructor Description GetObjectRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetObjectRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetBucketName()The name of the bucket.StringgetHttpResponseCacheControl()Specify this query parameter to override the Cache-Control response header in the GetObject response.StringgetHttpResponseContentDisposition()Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response.StringgetHttpResponseContentEncoding()Specify this query parameter to override the Content-Encoding response header in the GetObject response.StringgetHttpResponseContentLanguage()Specify this query parameter to override the Content-Language response header in the GetObject response.StringgetHttpResponseContentType()Specify this query parameter to override the Content-Type response header in the GetObject response.StringgetHttpResponseExpires()Specify this query parameter to override the Expires response header in the GetObject response.StringgetIfMatch()The entity tag (ETag) to match with the ETag of an existing resource.StringgetIfNoneMatch()The entity tag (ETag) to avoid matching.StringgetNamespaceName()The Object Storage namespace used for the request.StringgetObjectName()The name of the object.StringgetOpcClientRequestId()The client request ID for tracing.StringgetOpcSseCustomerAlgorithm()The optional header that specifies “AES256” as the encryption algorithm.StringgetOpcSseCustomerKey()The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data.StringgetOpcSseCustomerKeySha256()The optional header that specifies the base64-encoded SHA256 hash of the encryption key.RangegetRange()Optional byte range to fetch, as described in RFC 7233.StringgetVersionId()VersionId used to identify a particular version of the objectinthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.GetObjectRequest.BuildertoBuilder()Return an instance ofGetObjectRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getNamespaceName
public String getNamespaceName()
The Object Storage namespace used for the request.
-
getBucketName
public String getBucketName()
The name of the bucket.Avoid entering confidential information. Example: my-new-bucket1
-
getObjectName
public String getObjectName()
The name of the object.Avoid entering confidential information. Example: test/object1.log
-
getVersionId
public String getVersionId()
VersionId used to identify a particular version of the object
-
getIfMatch
public String getIfMatch()
The entity tag (ETag) to match with the ETag of an existing resource.If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.
-
getIfNoneMatch
public String getIfNoneMatch()
The entity tag (ETag) to avoid matching.Wildcards (‘*’) are not allowed. If the specified ETag does not match the ETag of the existing resource, the request returns the expected response. If the ETag matches the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
-
getOpcClientRequestId
public String getOpcClientRequestId()
The client request ID for tracing.
-
getRange
public Range getRange()
Optional byte range to fetch, as described in RFC 7233.Note that only a single range of bytes is supported.
-
getOpcSseCustomerAlgorithm
public String getOpcSseCustomerAlgorithm()
The optional header that specifies “AES256” as the encryption algorithm.For more information, see Using Your Own Keys for Server-Side Encryption.
-
getOpcSseCustomerKey
public String getOpcSseCustomerKey()
The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data.For more information, see Using Your Own Keys for Server-Side Encryption.
-
getOpcSseCustomerKeySha256
public String getOpcSseCustomerKeySha256()
The optional header that specifies the base64-encoded SHA256 hash of the encryption key.This value is used to check the integrity of the encryption key. For more information, see Using Your Own Keys for Server-Side Encryption.
-
getHttpResponseContentDisposition
public String getHttpResponseContentDisposition()
Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response.
-
getHttpResponseCacheControl
public String getHttpResponseCacheControl()
Specify this query parameter to override the Cache-Control response header in the GetObject response.
-
getHttpResponseContentType
public String getHttpResponseContentType()
Specify this query parameter to override the Content-Type response header in the GetObject response.
-
getHttpResponseContentLanguage
public String getHttpResponseContentLanguage()
Specify this query parameter to override the Content-Language response header in the GetObject response.
-
getHttpResponseContentEncoding
public String getHttpResponseContentEncoding()
Specify this query parameter to override the Content-Encoding response header in the GetObject response.
-
getHttpResponseExpires
public String getHttpResponseExpires()
Specify this query parameter to override the Expires response header in the GetObject response.
-
toBuilder
public GetObjectRequest.Builder toBuilder()
Return an instance ofGetObjectRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
GetObjectRequest.Builderthat allows you to modify request properties.
-
builder
public static GetObjectRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request object
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-