Class ListContainerImagesRequest

Inheritance

object

ListContainerImagesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ArtifactsService.Requests

Assembly: OCI.DotNetSDK.Artifacts.dll

Syntax

public class ListContainerImagesRequest : IOciRequest

Examples

Click here to see an example of how to use ListContainerImages request.

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

CompartmentIdInSubtree

Declaration

[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

Type	Description
bool?	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).

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the given display name exactly.

ImageId

Declaration

[HttpConverter(TargetEnum.Query, "imageId")]
public string ImageId { get; set; }

Property Value

Type	Description
string	A filter to return a container image summary only for the specified container image OCID.

IsVersioned

Declaration

[HttpConverter(TargetEnum.Query, "isVersioned")]
public bool? IsVersioned { get; set; }

Property Value

Type	Description
bool?	A filter to return container images based on whether there are any associated versions.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public string LifecycleState { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the given lifecycle state name exactly.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	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

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	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.

RepositoryId

Declaration

[HttpConverter(TargetEnum.Query, "repositoryId")]
public string RepositoryId { get; set; }

Property Value

Type	Description
string	A filter to return container images only for the specified container repository OCID.

RepositoryName

Declaration

[HttpConverter(TargetEnum.Query, "repositoryName")]
public string RepositoryName { get; set; }

Property Value

Type	Description
string	A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListContainerImagesRequest.SortByEnum? SortBy { get; set; }

Property Value

Type Description

Type	Description
ListContainerImagesRequest.SortByEnum?	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.

ListContainerImagesRequest.SortByEnum?

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.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListContainerImagesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListContainerImagesRequest.SortOrderEnum?	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.

Version

Declaration

[HttpConverter(TargetEnum.Query, "version")]
public string Version { get; set; }

Property Value

Type	Description
string	A filter to return container images that match the version. Example: foo or foo*

Implements

IOciRequest