com.oracle.bmc.identitydomains.requests

Class PatchOAuth2ClientCredentialRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<PatchOp>

com.oracle.bmc.identitydomains.requests.PatchOAuth2ClientCredentialRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public class PatchOAuth2ClientCredentialRequest
extends BmcRequest<PatchOp>

Example: Click here to see how to use PatchOAuth2ClientCredentialRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PatchOAuth2ClientCredentialRequest.Builder

Constructor Summary

Constructors

Constructor and Description
PatchOAuth2ClientCredentialRequest()

Method Summary

Modifier and Type	Method and Description
static PatchOAuth2ClientCredentialRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getAttributes() A comma-delimited string that specifies the names of resource attributes that should be returned in the response.
List<AttributeSets>	getAttributeSets() A multi-valued list of strings indicating the return type of attribute definition.
String	getAuthorization() The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
PatchOp	getBody$() Alternative accessor for the body parameter.
String	getIfMatch() Used to make the request conditional on an ETag
String	getOAuth2ClientCredentialId() ID of the resource
String	getOpcRetryToken() A token you supply to uniquely identify the request and provide idempotency if the request is retried.
PatchOp	getPatchOp() Update the OAuth2ClientCredential with SCIM Patch schema.
String	getResourceTypeSchemaVersion() An endpoint-specific schema version number to use in the Request.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
PatchOAuth2ClientCredentialRequest.Builder	toBuilder() Return an instance of PatchOAuth2ClientCredentialRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PatchOAuth2ClientCredentialRequest

public PatchOAuth2ClientCredentialRequest()

Method Detail

getOAuth2ClientCredentialId

public String getOAuth2ClientCredentialId()

ID of the resource

getAuthorization

public String getAuthorization()

The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

getResourceTypeSchemaVersion

public String getResourceTypeSchemaVersion()

An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

getAttributes

public String getAttributes()

A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

getAttributeSets

public List<AttributeSets> getAttributeSets()

A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If ‘attributes’ query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.

getPatchOp

public PatchOp getPatchOp()

Update the OAuth2ClientCredential with SCIM Patch schema.

Before you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.

Also, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.

getIfMatch

public String getIfMatch()

Used to make the request conditional on an ETag

getOpcRetryToken

public String getOpcRetryToken()

A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

getBody$

public PatchOp getBody$()

Alternative accessor for the body parameter.

Overrides:

getBody$ in class BmcRequest<PatchOp>

Returns:

body parameter

toBuilder

public PatchOAuth2ClientCredentialRequest.Builder toBuilder()

Return an instance of PatchOAuth2ClientCredentialRequest.Builder that allows you to modify request properties.

Returns:

instance of PatchOAuth2ClientCredentialRequest.Builder that allows you to modify request properties.

builder

public static PatchOAuth2ClientCredentialRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<PatchOp>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<PatchOp>