Interface RouteFerrySpan.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RouteFerrySpan.Builder,RouteFerrySpan>, SdkBuilder<RouteFerrySpan.Builder,RouteFerrySpan>, SdkPojo
Enclosing class:
RouteFerrySpan
@Mutable @NotThreadSafe public static interface RouteFerrySpan.Builder extends SdkPojo, CopyableBuilder<RouteFerrySpan.Builder,RouteFerrySpan>

  • Method Details

    • country

      RouteFerrySpan.Builder country(String country)

      3 letter Country code corresponding to the Span.

      Parameters:
      country - 3 letter Country code corresponding to the Span.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distance

      RouteFerrySpan.Builder distance(Long distance)

      Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: meters

      Parameters:
      distance - Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: meters

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • duration

      RouteFerrySpan.Builder duration(Long duration)

      Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: seconds

      Parameters:
      duration - Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: seconds

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geometryOffset

      RouteFerrySpan.Builder geometryOffset(Integer geometryOffset)

      Offset in the leg geometry corresponding to the start of this span.

      Parameters:
      geometryOffset - Offset in the leg geometry corresponding to the start of this span.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • names

      RouteFerrySpan.Builder names(Collection<LocalizedString> names)

      Provides an array of names of the ferry span in available languages.

      Parameters:
      names - Provides an array of names of the ferry span in available languages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • names

      RouteFerrySpan.Builder names(LocalizedString... names)

      Provides an array of names of the ferry span in available languages.

      Parameters:
      names - Provides an array of names of the ferry span in available languages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • names

      RouteFerrySpan.Builder names(Consumer<LocalizedString.Builder>... names)

      Provides an array of names of the ferry span in available languages.

      This is a convenience method that creates an instance of the LocalizedString.Builder avoiding the need to create one manually via LocalizedString.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to names(List<LocalizedString>).

      Parameters:
      names - a consumer that will call methods on LocalizedString.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • region

      RouteFerrySpan.Builder region(String region)

      2-3 letter Region code corresponding to the Span. This is either a province or a state.

      Parameters:
      region - 2-3 letter Region code corresponding to the Span. This is either a province or a state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.