public static class ListAnnotationsRequest.Builder extends Object implements BmcRequest.Builder<ListAnnotationsRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
ListAnnotationsRequest |
build()
Build the instance of ListAnnotationsRequest as configured by this builder
|
ListAnnotationsRequest |
buildWithoutInvocationCallback()
Build the instance of ListAnnotationsRequest as configured by this builder
|
ListAnnotationsRequest.Builder |
compartmentId(String compartmentId)
The ID of the compartment in which to list resources.
|
ListAnnotationsRequest.Builder |
copy(ListAnnotationsRequest o)
Copy method to populate the builder with values from the given instance.
|
ListAnnotationsRequest.Builder |
datasetId(String datasetId)
Filter the results by the OCID of the dataset.
|
ListAnnotationsRequest.Builder |
id(String id)
The unique OCID identifier.
|
ListAnnotationsRequest.Builder |
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
|
ListAnnotationsRequest.Builder |
lifecycleState(Annotation.LifecycleState lifecycleState)
A filter to return only resources whose lifecycleState matches the given lifecycleState.
|
ListAnnotationsRequest.Builder |
limit(Integer limit)
The maximum number of items to return.
|
ListAnnotationsRequest.Builder |
opcRequestId(String opcRequestId)
The client request ID for tracing.
|
ListAnnotationsRequest.Builder |
page(String page)
The page token representing the page at which to start retrieving results.
|
ListAnnotationsRequest.Builder |
recordId(String recordId)
The OCID of the record annotated.
|
ListAnnotationsRequest.Builder |
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
|
ListAnnotationsRequest.Builder |
sortBy(ListAnnotationsRequest.SortBy sortBy)
The field to sort by.
|
ListAnnotationsRequest.Builder |
sortOrder(SortOrders sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.
|
ListAnnotationsRequest.Builder |
timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)
The date and time the resource was created, in the timestamp format defined by RFC3339.
|
ListAnnotationsRequest.Builder |
timeCreatedLessThanOrEqualTo(Date timeCreatedLessThanOrEqualTo)
The date and time the resource was created, in the timestamp format defined by RFC3339.
|
ListAnnotationsRequest.Builder |
updatedBy(String updatedBy)
The OCID of the principal which updated the annotation.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
public ListAnnotationsRequest.Builder compartmentId(String compartmentId)
The ID of the compartment in which to list resources.
compartmentId
- the value to setpublic ListAnnotationsRequest.Builder datasetId(String datasetId)
Filter the results by the OCID of the dataset.
datasetId
- the value to setpublic ListAnnotationsRequest.Builder lifecycleState(Annotation.LifecycleState lifecycleState)
A filter to return only resources whose lifecycleState matches the given lifecycleState.
lifecycleState
- the value to setpublic ListAnnotationsRequest.Builder id(String id)
The unique OCID identifier.
id
- the value to setpublic ListAnnotationsRequest.Builder updatedBy(String updatedBy)
The OCID of the principal which updated the annotation.
updatedBy
- the value to setpublic ListAnnotationsRequest.Builder recordId(String recordId)
The OCID of the record annotated.
recordId
- the value to setpublic ListAnnotationsRequest.Builder timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)
The date and time the resource was created, in the timestamp format defined by RFC3339.
timeCreatedGreaterThanOrEqualTo
- the value to setpublic ListAnnotationsRequest.Builder timeCreatedLessThanOrEqualTo(Date timeCreatedLessThanOrEqualTo)
The date and time the resource was created, in the timestamp format defined by RFC3339.
timeCreatedLessThanOrEqualTo
- the value to setpublic ListAnnotationsRequest.Builder limit(Integer limit)
The maximum number of items to return.
limit
- the value to setpublic ListAnnotationsRequest.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.
page
- the value to setpublic ListAnnotationsRequest.Builder sortOrder(SortOrders sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.
sortOrder
- the value to setpublic ListAnnotationsRequest.Builder sortBy(ListAnnotationsRequest.SortBy sortBy)
The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. If no value is specified timeCreated is used by default.
sortBy
- the value to setpublic ListAnnotationsRequest.Builder opcRequestId(String opcRequestId)
The client request ID for tracing.
opcRequestId
- the value to setpublic ListAnnotationsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListAnnotationsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListAnnotationsRequest.Builder copy(ListAnnotationsRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListAnnotationsRequest,Void>
o
- other request from which to copy valuespublic ListAnnotationsRequest build()
Build the instance of ListAnnotationsRequest 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.
build
in interface BmcRequest.Builder<ListAnnotationsRequest,Void>
public ListAnnotationsRequest buildWithoutInvocationCallback()
Build the instance of ListAnnotationsRequest 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
Copyright © 2016–2024. All rights reserved.