Package de.captaingoldfish.scim.sdk.common.request

Class BulkRequestOperation.BulkRequestOperationBuilder

java.lang.Object
de.captaingoldfish.scim.sdk.common.request.BulkRequestOperation.BulkRequestOperationBuilder
Enclosing class:
BulkRequestOperation
public static class BulkRequestOperation.BulkRequestOperationBuilder extends Object
override lombok builder with public constructor

  • Constructor Details

    • BulkRequestOperationBuilder

      public BulkRequestOperationBuilder()

  • Method Details

    • method

      public BulkRequestOperation.BulkRequestOperationBuilder method(HttpMethod method)
      Parameters:
      method - The HTTP method of the current operation. Possible values are "POST", "PUT", "PATCH", or "DELETE". REQUIRED.
      Returns:
      this.

    • bulkId

      public BulkRequestOperation.BulkRequestOperationBuilder bulkId(String bulkId)
      Parameters:
      bulkId - The transient identifier of a newly created resource, unique within a bulk request and created by the client. The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request. REQUIRED when "method" is "POST".
      Returns:
      this.

    • path

      public BulkRequestOperation.BulkRequestOperationBuilder path(String path)
      Parameters:
      path - The resource's relative path to the SCIM service provider's root. If "method" is "POST", the value must specify a resource type endpoint, e.g., /Users or /Groups, whereas all other "method" values must specify the path to a specific resource, e.g., /Users/2819c223-7f76-453a-919d-413861904646. REQUIRED in a request.
      Returns:
      this.

    • data

      public BulkRequestOperation.BulkRequestOperationBuilder data(String data)
      Parameters:
      data - The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation. REQUIRED in a request when "method" is "POST", "PUT", or "PATCH".
      Returns:
      this.

    • version

      public BulkRequestOperation.BulkRequestOperationBuilder version(ETag version)
      Parameters:
      version - The version of the resource being returned. This value must be the same as the entity-tag (ETag) HTTP response header (see Sections 2.1 and 2.3 of [RFC7232]). This attribute has "caseExact" as "true". Service provider support for this attribute is optional and subject to the service provider's support for versioning (see Section 3.14 of [RFC7644]). If a service provider provides "version" (entity-tag) for a representation and the generation of that entity-tag does not satisfy all of the characteristics of a strong validator (see Section 2.1 of [RFC7232]), then the origin server MUST mark the "version" (entity-tag) as weak by prefixing its opaque value with "W/" (case sensitive).
      Returns:
      this.

    • returnResource

      public BulkRequestOperation.BulkRequestOperationBuilder returnResource(Boolean returnResource)
      Parameters:
      returnResource - this field allows clients to explicitly ask the server to return the created or modified resource in the bulk response. This does only work with the SCIM-SDK server implementation under the condition that the feature BulkConfig.isReturnResourcesEnabled() is enabled in the ServiceProvider configuration.
      Returns:
      this.

    • maxResourceLevel

      public BulkRequestOperation.BulkRequestOperationBuilder maxResourceLevel(Integer maxResourceLevel)
      Parameters:
      maxResourceLevel - this field allows clients to limit the number of transitive retrieved resources from the bulk-response to keep the response profile low. This is a custom feature usable with the SCIM-SDK server implementation that is only usable if the BulkConfig.isSupportBulkGet() feature is enabled within the ServiceProvider configuration.
      Returns:
      this.

    • build

      public BulkRequestOperation build()

    • toString

      public String toString()
      Overrides:
      toString in class Object