Package com.ibm.cloud.platform_services.global_catalog.v1.model

Class UpdateVisibilityOptions

java.lang.Object

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

com.ibm.cloud.platform_services.global_catalog.v1.model.UpdateVisibilityOptions

All Implemented Interfaces:

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

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

The updateVisibility options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	account()	Gets the account.
VisibilityDetail	exclude()	Gets the exclude.
java.lang.Boolean	extendable()	Gets the extendable.
java.lang.String	id()	Gets the id.
VisibilityDetail	include()	Gets the include.
UpdateVisibilityOptions.Builder	newBuilder()	New builder.
java.lang.String	restrictions()	Gets the restrictions.

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

New builder.

Returns:

a UpdateVisibilityOptions builder

id

public java.lang.String id()

Gets the id. The object's unique ID.

Returns:

the id

restrictions

public java.lang.String restrictions()

Gets the restrictions. This controls the overall visibility. It is an enum of *public*, *nonibm_only*, *ibm_only*, and *private*. public means it is visible to all. nonibm_only means it is visible to all except IBM unless their account is explicitly included, ibm_only means it is visible to all IBM unless their account is explicitly excluded. private means it is visible only to the included accounts.

Returns:

the restrictions

extendable

public java.lang.Boolean extendable()

Gets the extendable. Allows the visibility to be extendable.

Returns:

the extendable

include

public VisibilityDetail include()

Gets the include. Visibility details related to a catalog entry.

Returns:

the include

exclude

public VisibilityDetail exclude()

Gets the exclude. Visibility details related to a catalog entry.

Returns:

the exclude

account

public java.lang.String account()

Gets the account. This changes the scope of the request regardless of the authorization header. Example scopes are `account` and `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example `GET /?account=global`.

Returns:

the account