Package com.veeva.vault.sdk.api.query

Interface QueryShowRelationshipsRequest.Builder

Enclosing interface:
QueryShowRelationshipsRequest
public static interface QueryShowRelationshipsRequest.Builder
Creates an instance of QueryShowRelationshipsRequest. Requires calling withTargetName(String) to set the metadata query target in the FROM clause.

  • Method Details

    • withTargetName

      QueryShowRelationshipsRequest.Builder withTargetName(String targetName)
      Required: Sets the mandatory query target name in the FROM clause of the SHOW RELATIONSHIPS statement.

      Calling this method again replaces any previously set query target name. This method must be called at least once before build().

      Parameters:
      targetName - name of the target of the query
      Returns:
      this Builder

    • withLike

      QueryShowRelationshipsRequest.Builder withLike(String likeString)
      Optional: Sets a LIKE clause to filter the returned relationship names based on a pattern. For example, LIKE 'vql%'.

      If this method is called multiple times, the request retains only the value from the last call. If this method is never called, the request does not apply a LIKE filter and returns all queryable relationships.

      Parameters:
      likeString - LIKE clause
      Returns:
      this Builder

    • withQueryDescribe

      QueryShowRelationshipsRequest.Builder withQueryDescribe()
      Enables Query Describe on the SHOW RELATIONSHIPS query.
      Returns:
      this Builder

    • build

      QueryShowRelationshipsRequest build()
      Retrieves the completed QueryShowRelationshipsRequest.

      The metadata query target name must not be empty.

      Returns:
      the completed QueryShowRelationshipsRequest