Package com.google.api.generator.gapic.model

Class Method

java.lang.Object
com.google.api.generator.gapic.model.Method
public abstract class Method extends Object

  • Constructor Details

    • Method

      public Method()

  • Method Details

    • name

      public abstract String name()

    • stream

      public abstract Method.Stream stream()

    • inputType

      public abstract TypeNode inputType()

    • outputType

      public abstract TypeNode outputType()

    • isBatching

      public abstract boolean isBatching()

    • isPaged

      public boolean isPaged()

    • pageSizeFieldName

      @Nullable public abstract String pageSizeFieldName()

    • isDeprecated

      public abstract boolean isDeprecated()

    • lro

      @Nullable public abstract LongrunningOperation lro()

    • description

      @Nullable public abstract String description()

    • mixedInApiName

      @Nullable public abstract String mixedInApiName()

    • httpBindings

      @Nullable public abstract HttpBindings httpBindings()

    • routingHeaderRule

      @Nullable public abstract RoutingHeaderRule routingHeaderRule()

    • methodSignatures

      public abstract com.google.common.collect.ImmutableList<List<MethodArgument>> methodSignatures()

    • autoPopulatedFields

      public abstract List<String> autoPopulatedFields()

    • hasAutoPopulatedFields

      public boolean hasAutoPopulatedFields()
      If a service's service_config.yaml file contains method_settings.auto_populated_fields for this method, and the method is a Unary-type, then this is true

    • operationPollingMethod

      public abstract boolean operationPollingMethod()

    • hasLro

      public boolean hasLro()

    • hasDescription

      public boolean hasDescription()

    • hasHttpBindings

      public boolean hasHttpBindings()

    • hasRoutingHeaderParams

      public boolean hasRoutingHeaderParams()

    • shouldSetParamsExtractor

      public boolean shouldSetParamsExtractor()

    • isMixin

      public boolean isMixin()

    • isOperationPollingMethod

      public boolean isOperationPollingMethod()

    • isSupportedByTransport

      public boolean isSupportedByTransport(Transport transport)
      Determines if method is both eligible and enabled for the Transport. GRPC+REST Transport is not supported as each transport's sub composers will invoke this method the specific transport (GRPC or REST)
      Parameters:
      transport - Expects either GRPC or REST Transport
      Returns:
      boolean if method should be generated for the transport

    • toBuilder

      public abstract Method.Builder toBuilder()

    • builder

      public static Method.Builder builder()

    • toStream

      public static Method.Stream toStream(boolean isClientStreaming, boolean isServerStreaming)