Class ListContainerImagesRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.artifacts.requests.ListContainerImagesRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListContainerImagesRequest,Void>
- Enclosing class:
- ListContainerImagesRequest
public static class ListContainerImagesRequest.Builder extends Object implements BmcRequest.Builder<ListContainerImagesRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListContainerImagesRequest
build()
Build the instance of ListContainerImagesRequest as configured by this builderListContainerImagesRequest
buildWithoutInvocationCallback()
Build the instance of ListContainerImagesRequest as configured by this builderListContainerImagesRequest.Builder
compartmentId(String compartmentId)
The OCID of the compartment.ListContainerImagesRequest.Builder
compartmentIdInSubtree(Boolean compartmentIdInSubtree)
When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel.ListContainerImagesRequest.Builder
copy(ListContainerImagesRequest o)
Copy method to populate the builder with values from the given instance.ListContainerImagesRequest.Builder
displayName(String displayName)
A filter to return only resources that match the given display name exactly.ListContainerImagesRequest.Builder
imageId(String imageId)
A filter to return a container image summary only for the specified container image OCID.ListContainerImagesRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListContainerImagesRequest.Builder
isVersioned(Boolean isVersioned)
A filter to return container images based on whether there are any associated versions.ListContainerImagesRequest.Builder
lifecycleState(String lifecycleState)
A filter to return only resources that match the given lifecycle state name exactly.ListContainerImagesRequest.Builder
limit(Integer limit)
For list pagination.ListContainerImagesRequest.Builder
opcRequestId(String opcRequestId)
Unique identifier for the request.ListContainerImagesRequest.Builder
page(String page)
For list pagination.ListContainerImagesRequest.Builder
repositoryId(String repositoryId)
A filter to return container images only for the specified container repository OCID.ListContainerImagesRequest.Builder
repositoryName(String repositoryName)
A filter to return container images or container image signatures that match the repository name.ListContainerImagesRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListContainerImagesRequest.Builder
sortBy(ListContainerImagesRequest.SortBy sortBy)
The field to sort by.ListContainerImagesRequest.Builder
sortOrder(ListContainerImagesRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).ListContainerImagesRequest.Builder
version(String version)
A filter to return container images that match the version.-
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$
-
-
-
-
Method Detail
-
compartmentId
public ListContainerImagesRequest.Builder compartmentId(String compartmentId)
The OCID of the compartment.- Parameters:
compartmentId
- the value to set- Returns:
- this builder instance
-
compartmentIdInSubtree
public ListContainerImagesRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)
When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel.Default is false. Can only be set to true when calling the API on the tenancy (root compartment).
- Parameters:
compartmentIdInSubtree
- the value to set- Returns:
- this builder instance
-
displayName
public ListContainerImagesRequest.Builder displayName(String displayName)
A filter to return only resources that match the given display name exactly.- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
imageId
public ListContainerImagesRequest.Builder imageId(String imageId)
A filter to return a container image summary only for the specified container image OCID.- Parameters:
imageId
- the value to set- Returns:
- this builder instance
-
isVersioned
public ListContainerImagesRequest.Builder isVersioned(Boolean isVersioned)
A filter to return container images based on whether there are any associated versions.- Parameters:
isVersioned
- the value to set- Returns:
- this builder instance
-
repositoryId
public ListContainerImagesRequest.Builder repositoryId(String repositoryId)
A filter to return container images only for the specified container repository OCID.- Parameters:
repositoryId
- the value to set- Returns:
- this builder instance
-
repositoryName
public ListContainerImagesRequest.Builder repositoryName(String repositoryName)
A filter to return container images or container image signatures that match the repository name.Example: foo or foo*
- Parameters:
repositoryName
- the value to set- Returns:
- this builder instance
-
version
public ListContainerImagesRequest.Builder version(String version)
A filter to return container images that match the version.Example: foo or foo*
- Parameters:
version
- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListContainerImagesRequest.Builder lifecycleState(String lifecycleState)
A filter to return only resources that match the given lifecycle state name exactly.- Parameters:
lifecycleState
- the value to set- Returns:
- this builder instance
-
limit
public ListContainerImagesRequest.Builder limit(Integer limit)
For list pagination.The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
Example: 50
- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListContainerImagesRequest.Builder page(String page)
For list pagination.The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- Parameters:
page
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListContainerImagesRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.If you need to contact Oracle about a particular request, please provide the request ID.
- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
sortBy
public ListContainerImagesRequest.Builder sortBy(ListContainerImagesRequest.SortBy sortBy)
The field to sort by.You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
*Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListContainerImagesRequest.Builder sortOrder(ListContainerImagesRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).The DISPLAYNAME sort order is case sensitive.
- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListContainerImagesRequest.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 ListContainerImagesRequest.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 ListContainerImagesRequest.Builder copy(ListContainerImagesRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListContainerImagesRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListContainerImagesRequest build()
Build the instance of ListContainerImagesRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<ListContainerImagesRequest,Void>
- Returns:
- instance of ListContainerImagesRequest
-
buildWithoutInvocationCallback
public ListContainerImagesRequest buildWithoutInvocationCallback()
Build the instance of ListContainerImagesRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of ListContainerImagesRequest
-
-