com.hp.ov.sdk.rest.client.settings

Interface ScopeClient

All Superinterfaces:

RetrievableResource<Scope>, SearchableResource<Scope>

public interface ScopeClient
extends SearchableResource<Scope>, RetrievableResource<Scope>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScopeClient.IfMatchRequestInterceptor

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_ASSIGNMENTS
static String	SCOPES_URI

Method Summary

Modifier and Type	Method and Description
Scope	create(Scope scope) Creates a scope according to the provided scope object.
TaskResource	delete(String resourceId, RequestOption... options) Deletes the scope identified by the provided resourceId.
TaskResource	delete(String resourceId, String eTag, RequestOption... options) Deletes the scope identified by the provided resourceId.
TaskResource	patch(String resourceId, ResourceAssignment assignment, RequestOption... options) Applies a patch on the scope identified by resourceId according to the provided ResourceAssignment object.
Scope	update(String resourceId, Scope scope) Updates the scope identified by resourceId according to the provided scope object.
Scope	update(String resourceId, Scope scope, String eTag) Updates the scope identified by resourceId according to the provided scope object.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Field Detail

SCOPES_URI

static final String SCOPES_URI

See Also:

Constant Field Values

RESOURCE_ASSIGNMENTS

static final String RESOURCE_ASSIGNMENTS

See Also:

Constant Field Values

Method Detail

create

Scope create(Scope scope)

Creates a scope according to the provided scope object.

Parameters:

scope - object containing the details of the scope that should be created.

Returns:

Scope the created scope.

update

Scope update(String resourceId,
             Scope scope)

Updates the scope identified by resourceId according to the provided scope object.

Parameters:

resourceId - scope resource identifier.

scope - object containing the details of the scope that should be updated.

Returns:

Scope the updated scope.

update

Scope update(String resourceId,
             Scope scope,
             String eTag)

Updates the scope identified by resourceId according to the provided scope object.

The request is conditionally processed only if the current ETag for the scope matches the ETag passed as parameter.

Parameters:

resourceId - scope resource identifier.

scope - object containing the details of the scope that should be updated.

eTag - scope ETag.

Returns:

Scope

delete

TaskResource delete(String resourceId,
                    RequestOption... options)

Deletes the scope identified by the provided resourceId.

Parameters:

resourceId - scope resource identifier.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource task containing the result of this request.

delete

TaskResource delete(String resourceId,
                    String eTag,
                    RequestOption... options)

Deletes the scope identified by the provided resourceId.

The request is conditionally processed only if the current ETag for the scope matches the ETag passed as parameter.

Parameters:

resourceId - scope resource identifier.

eTag - scope ETag.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource task containing the result of this request.

patch

TaskResource patch(String resourceId,
                   ResourceAssignment assignment,
                   RequestOption... options)

Applies a patch on the scope identified by resourceId according to the provided ResourceAssignment object.

Parameters:

resourceId - scope resource identifier.

assignment - object containing the details of the modifications that should be applied.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource task containing the result of this request.