Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BulkActionResource

The bulk action resource entity.

Properties

entityType

entityType: string

The resource-type. To get the list of supported resource-types use {@link #listBulkActionResourceTypes(ListBulkActionResourceTypesRequest) listBulkActionResourceTypes}.

identifier

identifier: string

The resource OCID.

Optional metadata

metadata: undefined | object

Additional information that helps to identity the resource for bulk action.

The APIs to delete and move most resource types only require the resource identifier (ocid). But some resource-types require additional identifying information.

This information is provided in the resource's public API document. It is also available through the {@link #listBulkActionResourceTypes(ListBulkActionResourceTypesRequest) listBulkActionResourceTypes}.

*Example**: The APIs to delete or move the {@code buckets} resource-type require {@code namespaceName} and {@code bucketName} to identify the resource, as shown in the APIs, {@link #deleteBucket(DeleteBucketRequest) deleteBucket} and {@link #updateBucket(UpdateBucketRequest) updateBucket}.

To add a bucket for bulk actions, specify {@code namespaceName} and {@code bucketName} in the metadata property as shown in this example

{ \"identifier\": \"\" \"entityType\": \"bucket\", \"metadata\": { \"namespaceName\": \"sampleNamespace\", \"bucketName\": \"sampleBucket\" } }

Functions

getDeserializedJsonObj

getJsonObj