Package com.ibm.fhir.model.resource

Class Bundle.Entry.Request.Builder

    • Method Detail

      • id

        public Bundle.Entry.Request.Builder id​(java.lang.String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public Bundle.Entry.Request.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Bundle.Entry.Request.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public Bundle.Entry.Request.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Bundle.Entry.Request.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • method

        public Bundle.Entry.Request.Builder method​(HTTPVerb method)
        In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

        This element is required.

        Parameters:
        method - GET | HEAD | POST | PUT | DELETE | PATCH
        Returns:
        A reference to this Builder instance

      • url

        public Bundle.Entry.Request.Builder url​(Uri url)
        The URL for this entry, relative to the root (the address to which the request is posted).

        This element is required.

        Parameters:
        url - URL for HTTP equivalent of this entry
        Returns:
        A reference to this Builder instance

      • ifNoneMatch

        public Bundle.Entry.Request.Builder ifNoneMatch​(String ifNoneMatch)
        If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http. html#cread).
        Parameters:
        ifNoneMatch - For managing cache currency
        Returns:
        A reference to this Builder instance

      • ifModifiedSince

        public Bundle.Entry.Request.Builder ifModifiedSince​(Instant ifModifiedSince)
        Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http. html#cread).
        Parameters:
        ifModifiedSince - For managing cache currency
        Returns:
        A reference to this Builder instance

      • ifMatch

        public Bundle.Entry.Request.Builder ifMatch​(String ifMatch)
        Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
        Parameters:
        ifMatch - For managing update contention
        Returns:
        A reference to this Builder instance

      • ifNoneExist

        public Bundle.Entry.Request.Builder ifNoneExist​(String ifNoneExist)
        Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").
        Parameters:
        ifNoneExist - For conditional creates
        Returns:
        A reference to this Builder instance