com.ibm.cloud.ibm_key_protect_api.v2.model

Class GetKeyCollectionMetadataOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.ibm_key_protect_api.v2.model.GetKeyCollectionMetadataOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class GetKeyCollectionMetadataOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The getKeyCollectionMetadata options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetKeyCollectionMetadataOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	bluemixInstance() Gets the bluemixInstance.
String	correlationId() Gets the correlationId.
Boolean	extractable() Gets the extractable.
String	filter() Gets the filter.
GetKeyCollectionMetadataOptions.Builder	newBuilder() New builder.
List<Long>	state() Gets the state.
String	xKmsKeyRing() Gets the xKmsKeyRing.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public GetKeyCollectionMetadataOptions.Builder newBuilder()

New builder.

Returns:

a GetKeyCollectionMetadataOptions builder

bluemixInstance

public String bluemixInstance()

Gets the bluemixInstance. The IBM Cloud instance ID that identifies your Key Protect service instance.

Returns:

the bluemixInstance

correlationId

public String correlationId()

Gets the correlationId. The v4 UUID used to correlate and track transactions.

Returns:

the correlationId

state

public List<Long> state()

Gets the state. The state of the keys to be retrieved. States must be a list of integers from 0 to 5 delimited by commas with no whitespace or trailing commas. Valid states are based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values. **Usage:** If you want to retrieve active and deleted keys, use `../keys?state=1,5`.

Returns:

the state

extractable

public Boolean extractable()

Gets the extractable. The type of keys to be retrieved. Filters keys based on the `extractable` property. You can use this query parameter to search for keys whose material can leave the service. If set to `true`, standard keys will be retrieved. If set to `false`, root keys will be retrieved. If omitted, both root and standard keys will be retrieved. **Usage:** If you want to retrieve standard keys, use `../keys?extractable=true`.

Returns:

the extractable

filter

public String filter()

Gets the filter. When provided, returns the list of keys that match the queried properties. Each key property to be filtered on is specified as the property name itself, followed by an “=“ symbol, and then the value to filter on, followed by a space if there are more properties to filter only. Note: Anything between `<` and `>` in the examples or descriptions represent placeholder to specify the value *Basic format*: <propertyA>=<valueB> <propertyB>=<valueB> - The value to filter on may contain a value related to the property itself, or an operator followed by a value accepted by the operator - Only one operator and value, or one value is accepted per property at a time *Format with operator/value pair*: <propertyA>=<operatorA>:<valueA> Up to three of the same property may be specified at a time. The key properties that can be filtered at this time are: - `creationDate` * Date in RFC 3339 format in double-quotes: “YYYY-MM-DDTHH:mm:SSZ” - `deletionDate` * Date in RFC 3339 format in double-quotes: “YYYY-MM-DDTHH:mm:SSZ” - `expirationDate` * Date in RFC 3339 format in double-quotes: “YYYY-MM-DDTHH:mm:SSZ” - `extractable` * Boolean true or false without quotes, case-insensitive - `lastRotateDate` * Date in RFC 3339 format in double-quotes: “YYYY-MM-DDTHH:mm:SSZ” - `lastUpdateDate` * Date in RFC 3339 format in double-quotes: “YYYY-MM-DDTHH:mm:SSZ” - `state` * A list of comma-separated integers with no space in between: 0,1,2,3,5 Comparison operations (operators) that can be performed on date values are: - `lte:<value>` Less than or equal to - `lt:<value>` Less than - `gte:<value>` Greater than or equal to - `gt:<value>` Greater than A special keyword for date, `none` (case-insensitive), may be used to retreive keys that do not have that property. This is useful for `lastRotateDate`, where only keys that have never been rotated can be retreived. *Examples*: - `lastRotateDate="2022-02-15T00:00:00Z"` Filter keys that were last rotated on February 15, 2022 - `lastRotateDate=gte:"2022-02-15T00:00:00Z"` Filter keys that were last rotated after or on February 15, 2022 - `lastRotateDate=gte:"2022-02-15T00:00:00Z" lastRotateDate=lt:"2022-03-15T00:00:00Z"` Filter keys that were last rotated after or on February 15, 2022 but before (not including) March 15, 2022 - `lastRotateDate="2022-02-15T00:00:00Z" state=0,1,2,3,5 extractable=false` Filter root keys that were last rotated on February 15, 2022, with any state *Note*: When you filter by `state` or `extractable` in this query parameter, you will not be able to use the deprecated `state` or `extractable` independent query parameter. You will get a 400 response code if you specify a value for one of the two properties in both this filter query parameter and the deprecated independent query of the same name (the same applies vice versa).

Returns:

the filter

xKmsKeyRing

public String xKmsKeyRing()

Gets the xKmsKeyRing. The ID of the target key ring. If unspecified, all resources in the instance that the caller has access to will be returned. When the header is specified, only resources within the specified key ring, that the caller has access to, will be returned. The key ring ID of keys that are created without an `X-Kms-Key-Ring` header is: `default`.

Returns:

the xKmsKeyRing