Package com.oracle.bmc.devops.requests

Class ListProjectsRequest.Builder

java.lang.Object

com.oracle.bmc.devops.requests.ListProjectsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListProjectsRequest,Void>

Enclosing class:

ListProjectsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListProjectsRequest	build()	Build the instance of ListProjectsRequest as configured by this builder
ListProjectsRequest	buildWithoutInvocationCallback()	Build the instance of ListProjectsRequest as configured by this builder
ListProjectsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListProjectsRequest.Builder	copy(ListProjectsRequest o)	Copy method to populate the builder with values from the given instance.
ListProjectsRequest.Builder	id(String id)	Unique identifier or OCID for listing a single resource by ID.
ListProjectsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListProjectsRequest.Builder	lifecycleState(Project.LifecycleState lifecycleState)	A filter to return only Projects that matches the given lifecycleState.
ListProjectsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListProjectsRequest.Builder	name(String name)	A filter to return only resources that match the entire name given.
ListProjectsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListProjectsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListProjectsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListProjectsRequest.Builder	sortBy(ListProjectsRequest.SortBy sortBy)	The field to sort by.
ListProjectsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use.

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 ListProjectsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

id

public ListProjectsRequest.Builder id(String id)

Unique identifier or OCID for listing a single resource by ID.

Parameters:

id - the value to set

Returns:

this builder instance

lifecycleState

public ListProjectsRequest.Builder lifecycleState(Project.LifecycleState lifecycleState)

A filter to return only Projects that matches the given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

name

public ListProjectsRequest.Builder name(String name)

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

Parameters:

name - the value to set

Returns:

this builder instance

limit

public ListProjectsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListProjectsRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListProjectsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use.

Use either ascending or descending.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListProjectsRequest.Builder sortBy(ListProjectsRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListProjectsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListProjectsRequest.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 ListProjectsRequest.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 ListProjectsRequest.Builder copy(ListProjectsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListProjectsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListProjectsRequest build()

Build the instance of ListProjectsRequest 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<ListProjectsRequest,Void>

Returns:

instance of ListProjectsRequest

buildWithoutInvocationCallback

public ListProjectsRequest buildWithoutInvocationCallback()

Build the instance of ListProjectsRequest 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 ListProjectsRequest