Class ListImagesRequest

Inheritance

object

ListImagesRequest

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.CoreService.Requests

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class ListImagesRequest : IOciRequest

Examples

Click here to see an example of how to use ListImages 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

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.

LifecycleState

Declaration

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

Property Value

Type	Description
Image.LifecycleStateEnum?	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

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

OperatingSystem

Declaration

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

Property Value

Type	Description
string	The image's operating system. Example: Oracle Linux

OperatingSystemVersion

Declaration

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

Property Value

Type	Description
string	The image's operating system version. Example: 7.2

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.

Shape

Declaration

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

Property Value

Type	Description
string	Shape name.

SortBy

Declaration

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

Property Value

Type

Description

ListImagesRequest.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 ListImagesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

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

Implements

IOciRequest