Package com.openapi.v3

Class SecurityScheme.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>
com.openapi.v3.SecurityScheme.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SecuritySchemeOrBuilder, Cloneable
Enclosing class:
SecurityScheme
public static final class SecurityScheme.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder> implements SecuritySchemeOrBuilder
 Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect.   Please note that currently (2019) the implicit flow is about to be deprecated OAuth 2.0 Security Best Current Practice. Recommended for most use case is Authorization Code Grant flow with PKCE.
Protobuf type openapi.v3.SecurityScheme

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • clear

      public SecurityScheme.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • getDefaultInstanceForType

      public SecurityScheme getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SecurityScheme build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SecurityScheme buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public SecurityScheme.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • setField

      public SecurityScheme.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • clearField

      public SecurityScheme.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • clearOneof

      public SecurityScheme.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • setRepeatedField

      public SecurityScheme.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • addRepeatedField

      public SecurityScheme.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • mergeFrom

      public SecurityScheme.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecurityScheme.Builder>

    • mergeFrom

      public SecurityScheme.Builder mergeFrom(SecurityScheme other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • mergeFrom

      public SecurityScheme.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecurityScheme.Builder>
      Throws:
      IOException

    • getType

      public String getType()
      string type = 1 [json_name = "type"];
      Specified by:
      getType in interface SecuritySchemeOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
      string type = 1 [json_name = "type"];
      Specified by:
      getTypeBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for type.

    • setType

      public SecurityScheme.Builder setType(String value)
      string type = 1 [json_name = "type"];
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public SecurityScheme.Builder clearType()
      string type = 1 [json_name = "type"];
      Returns:
      This builder for chaining.

    • setTypeBytes

      public SecurityScheme.Builder setTypeBytes(com.google.protobuf.ByteString value)
      string type = 1 [json_name = "type"];
      Parameters:
      value - The bytes for type to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
      string description = 2 [json_name = "description"];
      Specified by:
      getDescription in interface SecuritySchemeOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      string description = 2 [json_name = "description"];
      Specified by:
      getDescriptionBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public SecurityScheme.Builder setDescription(String value)
      string description = 2 [json_name = "description"];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public SecurityScheme.Builder clearDescription()
      string description = 2 [json_name = "description"];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public SecurityScheme.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
      string description = 2 [json_name = "description"];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • getName

      public String getName()
      string name = 3 [json_name = "name"];
      Specified by:
      getName in interface SecuritySchemeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      string name = 3 [json_name = "name"];
      Specified by:
      getNameBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for name.

    • setName

      public SecurityScheme.Builder setName(String value)
      string name = 3 [json_name = "name"];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public SecurityScheme.Builder clearName()
      string name = 3 [json_name = "name"];
      Returns:
      This builder for chaining.

    • setNameBytes

      public SecurityScheme.Builder setNameBytes(com.google.protobuf.ByteString value)
      string name = 3 [json_name = "name"];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getIn

      public String getIn()
      string in = 4 [json_name = "in"];
      Specified by:
      getIn in interface SecuritySchemeOrBuilder
      Returns:
      The in.

    • getInBytes

      public com.google.protobuf.ByteString getInBytes()
      string in = 4 [json_name = "in"];
      Specified by:
      getInBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for in.

    • setIn

      public SecurityScheme.Builder setIn(String value)
      string in = 4 [json_name = "in"];
      Parameters:
      value - The in to set.
      Returns:
      This builder for chaining.

    • clearIn

      public SecurityScheme.Builder clearIn()
      string in = 4 [json_name = "in"];
      Returns:
      This builder for chaining.

    • setInBytes

      public SecurityScheme.Builder setInBytes(com.google.protobuf.ByteString value)
      string in = 4 [json_name = "in"];
      Parameters:
      value - The bytes for in to set.
      Returns:
      This builder for chaining.

    • getScheme

      public String getScheme()
      string scheme = 5 [json_name = "scheme"];
      Specified by:
      getScheme in interface SecuritySchemeOrBuilder
      Returns:
      The scheme.

    • getSchemeBytes

      public com.google.protobuf.ByteString getSchemeBytes()
      string scheme = 5 [json_name = "scheme"];
      Specified by:
      getSchemeBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for scheme.

    • setScheme

      public SecurityScheme.Builder setScheme(String value)
      string scheme = 5 [json_name = "scheme"];
      Parameters:
      value - The scheme to set.
      Returns:
      This builder for chaining.

    • clearScheme

      public SecurityScheme.Builder clearScheme()
      string scheme = 5 [json_name = "scheme"];
      Returns:
      This builder for chaining.

    • setSchemeBytes

      public SecurityScheme.Builder setSchemeBytes(com.google.protobuf.ByteString value)
      string scheme = 5 [json_name = "scheme"];
      Parameters:
      value - The bytes for scheme to set.
      Returns:
      This builder for chaining.

    • getBearerFormat

      public String getBearerFormat()
      string bearer_format = 6 [json_name = "bearerFormat"];
      Specified by:
      getBearerFormat in interface SecuritySchemeOrBuilder
      Returns:
      The bearerFormat.

    • getBearerFormatBytes

      public com.google.protobuf.ByteString getBearerFormatBytes()
      string bearer_format = 6 [json_name = "bearerFormat"];
      Specified by:
      getBearerFormatBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for bearerFormat.

    • setBearerFormat

      public SecurityScheme.Builder setBearerFormat(String value)
      string bearer_format = 6 [json_name = "bearerFormat"];
      Parameters:
      value - The bearerFormat to set.
      Returns:
      This builder for chaining.

    • clearBearerFormat

      public SecurityScheme.Builder clearBearerFormat()
      string bearer_format = 6 [json_name = "bearerFormat"];
      Returns:
      This builder for chaining.

    • setBearerFormatBytes

      public SecurityScheme.Builder setBearerFormatBytes(com.google.protobuf.ByteString value)
      string bearer_format = 6 [json_name = "bearerFormat"];
      Parameters:
      value - The bytes for bearerFormat to set.
      Returns:
      This builder for chaining.

    • hasFlows

      public boolean hasFlows()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
      Specified by:
      hasFlows in interface SecuritySchemeOrBuilder
      Returns:
      Whether the flows field is set.

    • getFlows

      public OauthFlows getFlows()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
      Specified by:
      getFlows in interface SecuritySchemeOrBuilder
      Returns:
      The flows.

    • setFlows

      public SecurityScheme.Builder setFlows(OauthFlows value)
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];

    • setFlows

      public SecurityScheme.Builder setFlows(OauthFlows.Builder builderForValue)
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];

    • mergeFlows

      public SecurityScheme.Builder mergeFlows(OauthFlows value)
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];

    • clearFlows

      public SecurityScheme.Builder clearFlows()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];

    • getFlowsBuilder

      public OauthFlows.Builder getFlowsBuilder()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];

    • getFlowsOrBuilder

      public OauthFlowsOrBuilder getFlowsOrBuilder()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
      Specified by:
      getFlowsOrBuilder in interface SecuritySchemeOrBuilder

    • getOpenIdConnectUrl

      public String getOpenIdConnectUrl()
      string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
      Specified by:
      getOpenIdConnectUrl in interface SecuritySchemeOrBuilder
      Returns:
      The openIdConnectUrl.

    • getOpenIdConnectUrlBytes

      public com.google.protobuf.ByteString getOpenIdConnectUrlBytes()
      string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
      Specified by:
      getOpenIdConnectUrlBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for openIdConnectUrl.

    • setOpenIdConnectUrl

      public SecurityScheme.Builder setOpenIdConnectUrl(String value)
      string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
      Parameters:
      value - The openIdConnectUrl to set.
      Returns:
      This builder for chaining.

    • clearOpenIdConnectUrl

      public SecurityScheme.Builder clearOpenIdConnectUrl()
      string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
      Returns:
      This builder for chaining.

    • setOpenIdConnectUrlBytes

      public SecurityScheme.Builder setOpenIdConnectUrlBytes(com.google.protobuf.ByteString value)
      string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
      Parameters:
      value - The bytes for openIdConnectUrl to set.
      Returns:
      This builder for chaining.

    • getSpecificationExtensionList

      public List<NamedAny> getSpecificationExtensionList()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionList in interface SecuritySchemeOrBuilder

    • getSpecificationExtensionCount

      public int getSpecificationExtensionCount()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionCount in interface SecuritySchemeOrBuilder

    • getSpecificationExtension

      public NamedAny getSpecificationExtension(int index)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtension in interface SecuritySchemeOrBuilder

    • setSpecificationExtension

      public SecurityScheme.Builder setSpecificationExtension(int index, NamedAny value)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • setSpecificationExtension

      public SecurityScheme.Builder setSpecificationExtension(int index, NamedAny.Builder builderForValue)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • addSpecificationExtension

      public SecurityScheme.Builder addSpecificationExtension(NamedAny value)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • addSpecificationExtension

      public SecurityScheme.Builder addSpecificationExtension(int index, NamedAny value)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • addSpecificationExtension

      public SecurityScheme.Builder addSpecificationExtension(NamedAny.Builder builderForValue)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • addSpecificationExtension

      public SecurityScheme.Builder addSpecificationExtension(int index, NamedAny.Builder builderForValue)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • addAllSpecificationExtension

      public SecurityScheme.Builder addAllSpecificationExtension(Iterable<? extends NamedAny> values)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • clearSpecificationExtension

      public SecurityScheme.Builder clearSpecificationExtension()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • removeSpecificationExtension

      public SecurityScheme.Builder removeSpecificationExtension(int index)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • getSpecificationExtensionBuilder

      public NamedAny.Builder getSpecificationExtensionBuilder(int index)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • getSpecificationExtensionOrBuilder

      public NamedAnyOrBuilder getSpecificationExtensionOrBuilder(int index)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilder in interface SecuritySchemeOrBuilder

    • getSpecificationExtensionOrBuilderList

      public List<? extends NamedAnyOrBuilder> getSpecificationExtensionOrBuilderList()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilderList in interface SecuritySchemeOrBuilder

    • addSpecificationExtensionBuilder

      public NamedAny.Builder addSpecificationExtensionBuilder()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • addSpecificationExtensionBuilder

      public NamedAny.Builder addSpecificationExtensionBuilder(int index)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • getSpecificationExtensionBuilderList

      public List<NamedAny.Builder> getSpecificationExtensionBuilderList()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];

    • setUnknownFields

      public final SecurityScheme.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

    • mergeUnknownFields

      public final SecurityScheme.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>