Class ListBucketsRequest

Inheritance
object
ListBucketsRequest
Implements
Inherited Members
Namespace: Oci.ObjectstorageService.Requests
Assembly: OCI.DotNetSDK.Objectstorage.dll
Syntax
public class ListBucketsRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

The ID of the compartment in which to list buckets.
Remarks

Required

Fields

Declaration
[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Csv)]
public List<ListBucketsRequest.FieldsEnum> Fields { get; set; }
Property Value
Type Description
List<ListBucketsRequest.FieldsEnum>

Bucket summary in list of buckets includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated', and 'etag' fields. This parameter can also include 'tags' (freeformTags and definedTags). The only supported value of this parameter is 'tags' for now. Example 'tags'.

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.

NamespaceName

Declaration
[Required(ErrorMessage = "NamespaceName is required.")]
[HttpConverter(TargetEnum.Path, "namespaceName")]
public string NamespaceName { get; set; }
Property Value
Type Description
string

The Object Storage namespace used for the request.
Remarks

Required

OpcClientRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-client-request-id")]
public string OpcClientRequestId { get; set; }
Property Value
Type Description
string

The client request ID for tracing.

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.

Implements