Package com.oracle.bmc.psql.requests

Class ListBackupsRequest.Builder

java.lang.Object

com.oracle.bmc.psql.requests.ListBackupsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListBackupsRequest,Void>

Enclosing class:

ListBackupsRequest

public static class ListBackupsRequest.Builder
extends Object
implements BmcRequest.Builder<ListBackupsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListBackupsRequest.Builder	backupId(String backupId)	A unique identifier for the backup.
ListBackupsRequest	build()	Build the instance of ListBackupsRequest as configured by this builder
ListBackupsRequest	buildWithoutInvocationCallback()	Build the instance of ListBackupsRequest as configured by this builder
ListBackupsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListBackupsRequest.Builder	copy(ListBackupsRequest o)	Copy method to populate the builder with values from the given instance.
ListBackupsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListBackupsRequest.Builder	id(String id)	A unique identifier for the database system.
ListBackupsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListBackupsRequest.Builder	lifecycleState(Backup.LifecycleState lifecycleState)	A filter to return only resources if their lifecycleState matches the given lifecycleState.
ListBackupsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListBackupsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListBackupsRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListBackupsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListBackupsRequest.Builder	sortBy(ListBackupsRequest.SortBy sortBy)	The field to sort by.
ListBackupsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘DESC’.
ListBackupsRequest.Builder	timeEnded(Date timeEnded)	The end date for getting backups.
ListBackupsRequest.Builder	timeStarted(Date timeStarted)	The start date for getting backups.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListBackupsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

timeStarted

public ListBackupsRequest.Builder timeStarted(Date timeStarted)

The start date for getting backups.

An RFC 3339 formatted datetime string.

Parameters:

timeStarted - the value to set

Returns:

this builder instance

timeEnded

public ListBackupsRequest.Builder timeEnded(Date timeEnded)

The end date for getting backups.

An RFC 3339 formatted datetime string.

Parameters:

timeEnded - the value to set

Returns:

this builder instance

lifecycleState

public ListBackupsRequest.Builder lifecycleState(Backup.LifecycleState lifecycleState)

A filter to return only resources if their lifecycleState matches the given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListBackupsRequest.Builder displayName(String displayName)

A filter to return only resources that match the entire display name given.

Parameters:

displayName - the value to set

Returns:

this builder instance

backupId

public ListBackupsRequest.Builder backupId(String backupId)

A unique identifier for the backup.

Parameters:

backupId - the value to set

Returns:

this builder instance

id

public ListBackupsRequest.Builder id(String id)

A unique identifier for the database system.

Parameters:

id - the value to set

Returns:

this builder instance

limit

public ListBackupsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListBackupsRequest.Builder page(String page)

A token representing the position at which to start retrieving results.

This must come from the opc-next-page header field of a previous response.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListBackupsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ‘ASC’ or ‘DESC’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListBackupsRequest.Builder sortBy(ListBackupsRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListBackupsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListBackupsRequest.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 ListBackupsRequest.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

copy

public ListBackupsRequest.Builder copy(ListBackupsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListBackupsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListBackupsRequest build()

Build the instance of ListBackupsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListBackupsRequest,Void>

Returns:

instance of ListBackupsRequest

buildWithoutInvocationCallback

public ListBackupsRequest buildWithoutInvocationCallback()

Build the instance of ListBackupsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListBackupsRequest