com.oracle.bmc.identitydomains.requests

Class CreateApiKeyRequest.Builder

java.lang.Object

com.oracle.bmc.identitydomains.requests.CreateApiKeyRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<CreateApiKeyRequest,ApiKey>

Enclosing class:

CreateApiKeyRequest

public static class CreateApiKeyRequest.Builder
extends Object
implements BmcRequest.Builder<CreateApiKeyRequest,ApiKey>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateApiKeyRequest.Builder	apiKey(ApiKey apiKey) ApiKey schema.
CreateApiKeyRequest.Builder	attributes(String attributes) A comma-delimited string that specifies the names of resource attributes that should be returned in the response.
CreateApiKeyRequest.Builder	attributeSets(AttributeSets singularValue) Singular setter.
CreateApiKeyRequest.Builder	attributeSets(List<AttributeSets> attributeSets) A multi-valued list of strings indicating the return type of attribute definition.
CreateApiKeyRequest.Builder	authorization(String authorization) The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
CreateApiKeyRequest.Builder	body$(ApiKey body) Alternative setter for the body parameter.
CreateApiKeyRequest	build() Build the instance of CreateApiKeyRequest as configured by this builder
CreateApiKeyRequest	buildWithoutInvocationCallback() Build the instance of CreateApiKeyRequest as configured by this builder
CreateApiKeyRequest.Builder	copy(CreateApiKeyRequest o) Copy method to populate the builder with values from the given instance.
CreateApiKeyRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
CreateApiKeyRequest.Builder	opcRetryToken(String opcRetryToken) A token you supply to uniquely identify the request and provide idempotency if the request is retried.
CreateApiKeyRequest.Builder	resourceTypeSchemaVersion(String resourceTypeSchemaVersion) An endpoint-specific schema version number to use in the Request.
CreateApiKeyRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

authorization

public CreateApiKeyRequest.Builder authorization(String authorization)

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

Parameters:

authorization - the value to set

Returns:

this builder instance

resourceTypeSchemaVersion

public CreateApiKeyRequest.Builder resourceTypeSchemaVersion(String resourceTypeSchemaVersion)

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.

Parameters:

resourceTypeSchemaVersion - the value to set

Returns:

this builder instance

attributes

public CreateApiKeyRequest.Builder attributes(String attributes)

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.

Parameters:

attributes - the value to set

Returns:

this builder instance

attributeSets

public CreateApiKeyRequest.Builder attributeSets(List<AttributeSets> attributeSets)

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.

Parameters:

attributeSets - the value to set

Returns:

this builder instance

attributeSets

public CreateApiKeyRequest.Builder attributeSets(AttributeSets singularValue)

Singular setter. 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.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

apiKey

public CreateApiKeyRequest.Builder apiKey(ApiKey apiKey)

ApiKey schema.

Before you specify an attribute-value in a request to create 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*.

Parameters:

apiKey - the value to set

Returns:

this builder instance

opcRetryToken

public CreateApiKeyRequest.Builder opcRetryToken(String opcRetryToken)

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

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

invocationCallback

public CreateApiKeyRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public CreateApiKeyRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public CreateApiKeyRequest.Builder copy(CreateApiKeyRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<CreateApiKeyRequest,ApiKey>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public CreateApiKeyRequest build()

Build the instance of CreateApiKeyRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<CreateApiKeyRequest,ApiKey>

Returns:

instance of CreateApiKeyRequest

body$

public CreateApiKeyRequest.Builder body$(ApiKey body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<CreateApiKeyRequest,ApiKey>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public CreateApiKeyRequest buildWithoutInvocationCallback()

Build the instance of CreateApiKeyRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of CreateApiKeyRequest