Interface ComponentResponse.Builder

    • Method Detail

      • componentName

        ComponentResponse.Builder componentName​(String componentName)

        The name of the component.

        Parameters:
        componentName - The name of the component.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • description

        ComponentResponse.Builder description​(String description)

        The description of the component type.

        Parameters:
        description - The description of the component type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • componentTypeId

        ComponentResponse.Builder componentTypeId​(String componentTypeId)

        The ID of the component type.

        Parameters:
        componentTypeId - The ID of the component type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        ComponentResponse.Builder status​(Status status)

        The status of the component type.

        Parameters:
        status - The status of the component type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • definedIn

        ComponentResponse.Builder definedIn​(String definedIn)

        The name of the property definition set in the request.

        Parameters:
        definedIn - The name of the property definition set in the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • properties

        ComponentResponse.Builder properties​(Map<String,​PropertyResponse> properties)

        An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

        Parameters:
        properties - An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • syncSource

        ComponentResponse.Builder syncSource​(String syncSource)

        The syncSource of the sync job, if this entity was created by a sync job.

        Parameters:
        syncSource - The syncSource of the sync job, if this entity was created by a sync job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • areAllPropertiesReturned

        ComponentResponse.Builder areAllPropertiesReturned​(Boolean areAllPropertiesReturned)

        This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.

        Parameters:
        areAllPropertiesReturned - This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • compositeComponents

        ComponentResponse.Builder compositeComponents​(Map<String,​ComponentSummary> compositeComponents)

        This lists objects that contain information about the compositeComponents.

        Parameters:
        compositeComponents - This lists objects that contain information about the compositeComponents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • areAllCompositeComponentsReturned

        ComponentResponse.Builder areAllCompositeComponentsReturned​(Boolean areAllCompositeComponentsReturned)

        This flag notes whether all compositeComponents are returned in the API response.

        Parameters:
        areAllCompositeComponentsReturned - This flag notes whether all compositeComponents are returned in the API response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.