ListManagementAgentsRequest.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.managementagent.requests.ListManagementAgentsRequest.Builder

All Implemented Interfaces:: BmcRequest.Builder<ListManagementAgentsRequest,Void>

Enclosing class:: ListManagementAgentsRequest

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

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListManagementAgentsRequest.Builder`	`accessLevel(String accessLevel)` When the value is “ACCESSIBLE”, insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
`ListManagementAgentsRequest.Builder`	`availabilityStatus(AvailabilityStatus availabilityStatus)` Filter to return only Management Agents in the particular availability status.
`ListManagementAgentsRequest`	`build()` Build the instance of ListManagementAgentsRequest as configured by this builder
`ListManagementAgentsRequest`	`buildWithoutInvocationCallback()` Build the instance of ListManagementAgentsRequest as configured by this builder
`ListManagementAgentsRequest.Builder`	`compartmentId(String compartmentId)` The OCID of the compartment to which a request will be scoped.
`ListManagementAgentsRequest.Builder`	`compartmentIdInSubtree(Boolean compartmentIdInSubtree)` if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
`ListManagementAgentsRequest.Builder`	`copy(ListManagementAgentsRequest o)` Copy method to populate the builder with values from the given instance.
`ListManagementAgentsRequest.Builder`	`dataSourceName(List<String> dataSourceName)` Unique name of the dataSource.
`ListManagementAgentsRequest.Builder`	`dataSourceName(String singularValue)` Singular setter.
`ListManagementAgentsRequest.Builder`	`dataSourceType(DataSourceTypes dataSourceType)` The type of the dataSource.
`ListManagementAgentsRequest.Builder`	`displayName(String displayName)` Filter to return only Management Agents having the particular display name.
`ListManagementAgentsRequest.Builder`	`gatewayId(List<String> gatewayId)` Filter to return only results having the particular gatewayId.
`ListManagementAgentsRequest.Builder`	`gatewayId(String singularValue)` Singular setter.
`ListManagementAgentsRequest.Builder`	`hostId(String hostId)` Filter to return only Management Agents having the particular agent host id.
`ListManagementAgentsRequest.Builder`	`installType(InstallTypes installType)` A filter to return either agents or gateway types depending upon install type selected by user.
`ListManagementAgentsRequest.Builder`	`invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)` Set the invocation callback for the request to be built.
`ListManagementAgentsRequest.Builder`	`isCustomerDeployed(Boolean isCustomerDeployed)` true, if the agent image is manually downloaded and installed.
`ListManagementAgentsRequest.Builder`	`lifecycleState(LifecycleStates lifecycleState)` Filter to return only Management Agents in the particular lifecycle state.
`ListManagementAgentsRequest.Builder`	`limit(Integer limit)` The maximum number of items to return.
`ListManagementAgentsRequest.Builder`	`opcRequestId(String opcRequestId)` The client request ID for tracing.
`ListManagementAgentsRequest.Builder`	`page(String page)` The page token representing the page at which to start retrieving results.
`ListManagementAgentsRequest.Builder`	`platformType(List<PlatformTypes> platformType)` Filter to return only results having the particular platform type.
`ListManagementAgentsRequest.Builder`	`platformType(PlatformTypes singularValue)` Singular setter.
`ListManagementAgentsRequest.Builder`	`pluginName(List<String> pluginName)` Filter to return only Management Agents having the particular Plugin installed.
`ListManagementAgentsRequest.Builder`	`pluginName(String singularValue)` Singular setter.
`ListManagementAgentsRequest.Builder`	`retryConfiguration(RetryConfiguration retryConfiguration)` Set the retry configuration for the request to be built.
`ListManagementAgentsRequest.Builder`	`sortBy(ListManagementAgentsRequest.SortBy sortBy)` The field to sort by.
`ListManagementAgentsRequest.Builder`	`sortOrder(ListManagementAgentsRequest.SortOrder sortOrder)` The sort order to use, either ‘asc’ or ‘desc’.
`ListManagementAgentsRequest.Builder`	`version(List<String> version)` Filter to return only Management Agents having the particular agent version.
`ListManagementAgentsRequest.Builder`	`version(String singularValue)` Singular setter.

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 ListManagementAgentsRequest.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment to which a request will be scoped.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder instance
  - pluginName
```
public ListManagementAgentsRequest.Builder pluginName(List<String> pluginName)
```
    Filter to return only Management Agents having the particular Plugin installed. A special pluginName of ‘None’ can be provided and this will return only Management Agents having no plugin installed.
    
    Parameters:
    
    pluginName - the value to set
    
    Returns:
    
    this builder instance
  - pluginName
```
public ListManagementAgentsRequest.Builder pluginName(String singularValue)
```
    Singular setter. Filter to return only Management Agents having the particular Plugin installed. A special pluginName of ‘None’ can be provided and this will return only Management Agents having no plugin installed.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - version
```
public ListManagementAgentsRequest.Builder version(List<String> version)
```
    Filter to return only Management Agents having the particular agent version.
    
    Parameters:
    
    version - the value to set
    
    Returns:
    
    this builder instance
  - version
```
public ListManagementAgentsRequest.Builder version(String singularValue)
```
    Singular setter. Filter to return only Management Agents having the particular agent version.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - displayName
```
public ListManagementAgentsRequest.Builder displayName(String displayName)
```
    Filter to return only Management Agents having the particular display name.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder instance
  - lifecycleState
```
public ListManagementAgentsRequest.Builder lifecycleState(LifecycleStates lifecycleState)
```
    Filter to return only Management Agents in the particular lifecycle state.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder instance
  - availabilityStatus
```
public ListManagementAgentsRequest.Builder availabilityStatus(AvailabilityStatus availabilityStatus)
```
    Filter to return only Management Agents in the particular availability status.
    
    Parameters:
    
    availabilityStatus - the value to set
    
    Returns:
    
    this builder instance
  - hostId
```
public ListManagementAgentsRequest.Builder hostId(String hostId)
```
    Filter to return only Management Agents having the particular agent host id.
    
    Parameters:
    
    hostId - the value to set
    
    Returns:
    
    this builder instance
  - platformType
```
public ListManagementAgentsRequest.Builder platformType(List<PlatformTypes> platformType)
```
    Filter to return only results having the particular platform type.
    
    Parameters:
    
    platformType - the value to set
    
    Returns:
    
    this builder instance
  - platformType
```
public ListManagementAgentsRequest.Builder platformType(PlatformTypes singularValue)
```
    Singular setter. Filter to return only results having the particular platform type.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - isCustomerDeployed
```
public ListManagementAgentsRequest.Builder isCustomerDeployed(Boolean isCustomerDeployed)
```
    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
    
    Parameters:
    
    isCustomerDeployed - the value to set
    
    Returns:
    
    this builder instance
  - installType
```
public ListManagementAgentsRequest.Builder installType(InstallTypes installType)
```
    A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
    
    Parameters:
    
    installType - the value to set
    
    Returns:
    
    this builder instance
  - gatewayId
```
public ListManagementAgentsRequest.Builder gatewayId(List<String> gatewayId)
```
    Filter to return only results having the particular gatewayId.
    
    Parameters:
    
    gatewayId - the value to set
    
    Returns:
    
    this builder instance
  - gatewayId
```
public ListManagementAgentsRequest.Builder gatewayId(String singularValue)
```
    Singular setter. Filter to return only results having the particular gatewayId.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - limit
```
public ListManagementAgentsRequest.Builder limit(Integer limit)
```
    The maximum number of items to return.
    
    Parameters:
    
    limit - the value to set
    
    Returns:
    
    this builder instance
  - page
```
public ListManagementAgentsRequest.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 ListManagementAgentsRequest.Builder sortOrder(ListManagementAgentsRequest.SortOrder sortOrder)
```
    The sort order to use, either ‘asc’ or ‘desc’.
    
    Parameters:
    
    sortOrder - the value to set
    
    Returns:
    
    this builder instance
  - sortBy
```
public ListManagementAgentsRequest.Builder sortBy(ListManagementAgentsRequest.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 ListManagementAgentsRequest.Builder opcRequestId(String opcRequestId)
```
    The client request ID for tracing.
    
    Parameters:
    
    opcRequestId - the value to set
    
    Returns:
    
    this builder instance
  - compartmentIdInSubtree
```
public ListManagementAgentsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)
```
    if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
    
    Parameters:
    
    compartmentIdInSubtree - the value to set
    
    Returns:
    
    this builder instance
  - accessLevel
```
public ListManagementAgentsRequest.Builder accessLevel(String accessLevel)
```
    When the value is “ACCESSIBLE”, insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
    
    Parameters:
    
    accessLevel - the value to set
    
    Returns:
    
    this builder instance
  - dataSourceType
```
public ListManagementAgentsRequest.Builder dataSourceType(DataSourceTypes dataSourceType)
```
    The type of the dataSource.
    
    Parameters:
    
    dataSourceType - the value to set
    
    Returns:
    
    this builder instance
  - dataSourceName
```
public ListManagementAgentsRequest.Builder dataSourceName(List<String> dataSourceName)
```
    Unique name of the dataSource.
    
    Parameters:
    
    dataSourceName - the value to set
    
    Returns:
    
    this builder instance
  - dataSourceName
```
public ListManagementAgentsRequest.Builder dataSourceName(String singularValue)
```
    Singular setter. Unique name of the dataSource.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - invocationCallback
```
public ListManagementAgentsRequest.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 ListManagementAgentsRequest.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 ListManagementAgentsRequest.Builder copy(ListManagementAgentsRequest o)
```
    Copy method to populate the builder with values from the given instance.
    
    Specified by:
    
    copy in interface BmcRequest.Builder<ListManagementAgentsRequest,Void>
    
    Parameters:
    
    o - other request from which to copy values
    
    Returns:
    
    this builder instance
  - build
```
public ListManagementAgentsRequest build()
```
    Build the instance of ListManagementAgentsRequest 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<ListManagementAgentsRequest,Void>
    
    Returns:
    
    instance of ListManagementAgentsRequest
  - buildWithoutInvocationCallback
```
public ListManagementAgentsRequest buildWithoutInvocationCallback()
```
    Build the instance of ListManagementAgentsRequest 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 ListManagementAgentsRequest

Class ListManagementAgentsRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

Method Detail

compartmentId

pluginName

pluginName

version

version

displayName

lifecycleState

availabilityStatus

hostId

platformType

platformType

isCustomerDeployed

installType

gatewayId

gatewayId

limit

page

sortOrder

sortBy

opcRequestId

compartmentIdInSubtree

accessLevel

dataSourceType

dataSourceName

dataSourceName

invocationCallback

retryConfiguration

copy

build

buildWithoutInvocationCallback