Class ListContainersRequest

Inheritance

object

ListContainersRequest

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

Assembly: OCI.DotNetSDK.Containerinstances.dll

Syntax

public class ListContainersRequest : IOciRequest

Examples

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

Properties

AvailabilityDomain

Declaration

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

Property Value

Type	Description
string	The name of the availability domain. Example: Uocm:PHX-AD-1

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 in which to list resources.

Remarks

Required

ContainerInstanceId

Declaration

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

Property Value

Type	Description
string	The OCID of the container instance.

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 entire display name given.

LifecycleState

Declaration

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

Property Value

Type	Description
Container.LifecycleStateEnum?	A filter to only return resources that match the given lifecycle state.

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.

OpcRequestId

Declaration

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

Property Value

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

SortBy

Declaration

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

Property Value

Type	Description
ListContainersRequest.SortByEnum?	The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don't specify a value, timeCreated is the default.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrder?	The sort order to use (ASC) or (DESC).

Implements

IOciRequest