Class PutSchemaRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • schemaId

        public PutSchemaRequest.Builder schemaId​(String schemaId)
        ID of the resource
        Parameters:
        schemaId - the value to set
        Returns:
        this builder instance
      • authorization

        public PutSchemaRequest.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 PutSchemaRequest.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
      • schema

        public PutSchemaRequest.Builder schema​(Schema schema)
        Replace the current instance of Schema with provided payload.

        Before you specify an attribute-value in a request to replace 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:
        schema - the value to set
        Returns:
        this builder instance
      • ifMatch

        public PutSchemaRequest.Builder ifMatch​(String ifMatch)
        Used to make the request conditional on an ETag
        Parameters:
        ifMatch - the value to set
        Returns:
        this builder instance
      • opcRetryToken

        public PutSchemaRequest.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 PutSchemaRequest.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 PutSchemaRequest.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