com.oracle.bmc.cloudguard.requests

Class ListSecurityZonesRequest.Builder

java.lang.Object

com.oracle.bmc.cloudguard.requests.ListSecurityZonesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSecurityZonesRequest,Void>

Enclosing class:

ListSecurityZonesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListSecurityZonesRequest	build() Build the instance of ListSecurityZonesRequest as configured by this builder
ListSecurityZonesRequest	buildWithoutInvocationCallback() Build the instance of ListSecurityZonesRequest as configured by this builder
ListSecurityZonesRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment in which to list resources.
ListSecurityZonesRequest.Builder	copy(ListSecurityZonesRequest o) Copy method to populate the builder with values from the given instance.
ListSecurityZonesRequest.Builder	displayName(String displayName) A filter to return only resources that match the entire display name given.
ListSecurityZonesRequest.Builder	id(String id) The unique identifier of the security zone (SecurityZone resource).
ListSecurityZonesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListSecurityZonesRequest.Builder	isRequiredSecurityZonesInSubtree(Boolean isRequiredSecurityZonesInSubtree) Is security zones in the subtree?
ListSecurityZonesRequest.Builder	lifecycleState(LifecycleState lifecycleState) The field lifecycle state.
ListSecurityZonesRequest.Builder	limit(Integer limit) The maximum number of items to return
ListSecurityZonesRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListSecurityZonesRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListSecurityZonesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListSecurityZonesRequest.Builder	securityRecipeId(String securityRecipeId) The unique identifier of the security zone recipe.
ListSecurityZonesRequest.Builder	sortBy(ListSecurityZonesRequest.SortBy sortBy) The field to sort by.
ListSecurityZonesRequest.Builder	sortOrder(SortOrders 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 ListSecurityZonesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListSecurityZonesRequest.Builder lifecycleState(LifecycleState lifecycleState)

The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

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

id

public ListSecurityZonesRequest.Builder id(String id)

The unique identifier of the security zone (SecurityZone resource).

Parameters:

id - the value to set

Returns:

this builder instance

securityRecipeId

public ListSecurityZonesRequest.Builder securityRecipeId(String securityRecipeId)

The unique identifier of the security zone recipe. (SecurityRecipe resource).

Parameters:

securityRecipeId - the value to set

Returns:

this builder instance

isRequiredSecurityZonesInSubtree

public ListSecurityZonesRequest.Builder isRequiredSecurityZonesInSubtree(Boolean isRequiredSecurityZonesInSubtree)

Is security zones in the subtree?

Parameters:

isRequiredSecurityZonesInSubtree - the value to set

Returns:

this builder instance

limit

public ListSecurityZonesRequest.Builder limit(Integer limit)

The maximum number of items to return

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListSecurityZonesRequest.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 ListSecurityZonesRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListSecurityZonesRequest.Builder sortBy(ListSecurityZonesRequest.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. If no value is specified timeCreated is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListSecurityZonesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSecurityZonesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSecurityZonesRequest build()

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

Returns:

instance of ListSecurityZonesRequest

buildWithoutInvocationCallback

public ListSecurityZonesRequest buildWithoutInvocationCallback()

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