Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.JSONSchema.FieldConfigurationOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getDeprecated()
      Declares this field to be deprecated.
      java.lang.String getPathParamName()
      Alternative parameter name when used as path parameter.
      com.google.protobuf.ByteString getPathParamNameBytes()
      Alternative parameter name when used as path parameter.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getPathParamName

        java.lang.String getPathParamName()
         Alternative parameter name when used as path parameter. If set, this will
 be used as the complete parameter name when this field is used as a path
 parameter. Use this to avoid having auto generated path parameter names
 for overlapping paths.
        string path_param_name = 47;
        Returns:
        The pathParamName.

      • getPathParamNameBytes

        com.google.protobuf.ByteString getPathParamNameBytes()
         Alternative parameter name when used as path parameter. If set, this will
 be used as the complete parameter name when this field is used as a path
 parameter. Use this to avoid having auto generated path parameter names
 for overlapping paths.
        string path_param_name = 47;
        Returns:
        The bytes for pathParamName.

      • getDeprecated

        boolean getDeprecated()
         Declares this field to be deprecated. Allows for the generated OpenAPI
 parameter to be marked as deprecated without affecting the proto field.
        bool deprecated = 49;
        Returns:
        The deprecated.