Package com.oracle.bmc.objectstorage.requests

Class GetObjectRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • namespaceName

        public GetObjectRequest.Builder namespaceName​(String namespaceName)
        The Object Storage namespace used for the request.
        Parameters:
        namespaceName - the value to set
        Returns:
        this builder instance

      • bucketName

        public GetObjectRequest.Builder bucketName​(String bucketName)
        The name of the bucket.

        Avoid entering confidential information. Example: my-new-bucket1

        Parameters:
        bucketName - the value to set
        Returns:
        this builder instance

      • objectName

        public GetObjectRequest.Builder objectName​(String objectName)
        The name of the object.

        Avoid entering confidential information. Example: test/object1.log

        Parameters:
        objectName - the value to set
        Returns:
        this builder instance

      • versionId

        public GetObjectRequest.Builder versionId​(String versionId)
        VersionId used to identify a particular version of the object
        Parameters:
        versionId - the value to set
        Returns:
        this builder instance

      • ifMatch

        public GetObjectRequest.Builder ifMatch​(String ifMatch)
        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.

        Parameters:
        ifMatch - the value to set
        Returns:
        this builder instance

      • ifNoneMatch

        public GetObjectRequest.Builder ifNoneMatch​(String ifNoneMatch)
        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.

        Parameters:
        ifNoneMatch - the value to set
        Returns:
        this builder instance

      • opcClientRequestId

        public GetObjectRequest.Builder opcClientRequestId​(String opcClientRequestId)
        The client request ID for tracing.
        Parameters:
        opcClientRequestId - the value to set
        Returns:
        this builder instance

      • range

        public GetObjectRequest.Builder range​(Range range)
        Optional byte range to fetch, as described in RFC 7233.

        Note that only a single range of bytes is supported.

        Parameters:
        range - the value to set
        Returns:
        this builder instance

      • opcSseCustomerKeySha256

        public GetObjectRequest.Builder opcSseCustomerKeySha256​(String opcSseCustomerKeySha256)
        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.

        Parameters:
        opcSseCustomerKeySha256 - the value to set
        Returns:
        this builder instance

      • httpResponseContentDisposition

        public GetObjectRequest.Builder httpResponseContentDisposition​(String httpResponseContentDisposition)
        Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response.
        Parameters:
        httpResponseContentDisposition - the value to set
        Returns:
        this builder instance

      • httpResponseCacheControl

        public GetObjectRequest.Builder httpResponseCacheControl​(String httpResponseCacheControl)
        Specify this query parameter to override the Cache-Control response header in the GetObject response.
        Parameters:
        httpResponseCacheControl - the value to set
        Returns:
        this builder instance

      • httpResponseContentType

        public GetObjectRequest.Builder httpResponseContentType​(String httpResponseContentType)
        Specify this query parameter to override the Content-Type response header in the GetObject response.
        Parameters:
        httpResponseContentType - the value to set
        Returns:
        this builder instance

      • httpResponseContentLanguage

        public GetObjectRequest.Builder httpResponseContentLanguage​(String httpResponseContentLanguage)
        Specify this query parameter to override the Content-Language response header in the GetObject response.
        Parameters:
        httpResponseContentLanguage - the value to set
        Returns:
        this builder instance

      • httpResponseContentEncoding

        public GetObjectRequest.Builder httpResponseContentEncoding​(String httpResponseContentEncoding)
        Specify this query parameter to override the Content-Encoding response header in the GetObject response.
        Parameters:
        httpResponseContentEncoding - the value to set
        Returns:
        this builder instance

      • httpResponseExpires

        public GetObjectRequest.Builder httpResponseExpires​(String httpResponseExpires)
        Specify this query parameter to override the Expires response header in the GetObject response.
        Parameters:
        httpResponseExpires - the value to set
        Returns:
        this builder instance

      • invocationCallback

        public GetObjectRequest.Builder invocationCallback​(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
        Set the invocation callback for the request to be built.
        Parameters:
        invocationCallback - the invocation callback to be set for the request
        Returns:
        this builder instance

      • retryConfiguration

        public GetObjectRequest.Builder retryConfiguration​(RetryConfiguration retryConfiguration)
        Set the retry configuration for the request to be built.
        Parameters:
        retryConfiguration - the retry configuration to be used for the request
        Returns:
        this builder instance