com.ibm.cloud.platform_services.context_based_restrictions.v1.model

Class CreateRuleOptions

java.lang.Object

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

com.ibm.cloud.platform_services.context_based_restrictions.v1.model.CreateRuleOptions

All Implemented Interfaces:

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

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

The createRule options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
java.util.List<RuleContext>	contexts() Gets the contexts.
java.lang.String	description() Gets the description.
CreateRuleOptions.Builder	newBuilder() New builder.
java.util.List<Resource>	resources() Gets the resources.
java.lang.String	transactionId() Gets the transactionId.
java.lang.String	xCorrelationId() Gets the xCorrelationId.

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 CreateRuleOptions.Builder newBuilder()

New builder.

Returns:

a CreateRuleOptions builder

description

public java.lang.String description()

Gets the description. The description of the rule.

Returns:

the description

contexts

public java.util.List<RuleContext> contexts()

Gets the contexts. The contexts this rule applies to.

Returns:

the contexts

resources

public java.util.List<Resource> resources()

Gets the resources. The resources this rule apply to.

Returns:

the resources

xCorrelationId

public java.lang.String xCorrelationId()

Gets the xCorrelationId. The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

Returns:

the xCorrelationId

transactionId

public java.lang.String transactionId()

Gets the transactionId. The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.

Returns:

the transactionId