java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.Key
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, KeyOrBuilder, Serializable

@Generated public final class Key extends com.google.protobuf.GeneratedMessage implements KeyOrBuilder
 A key used to identify and configure applications (web and/or mobile) that
 use reCAPTCHA Enterprise.
 
Protobuf type google.cloud.recaptchaenterprise.v1.Key
See Also:
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:
    • WEB_SETTINGS_FIELD_NUMBER

      public static final int WEB_SETTINGS_FIELD_NUMBER
      See Also:
    • ANDROID_SETTINGS_FIELD_NUMBER

      public static final int ANDROID_SETTINGS_FIELD_NUMBER
      See Also:
    • IOS_SETTINGS_FIELD_NUMBER

      public static final int IOS_SETTINGS_FIELD_NUMBER
      See Also:
    • EXPRESS_SETTINGS_FIELD_NUMBER

      public static final int EXPRESS_SETTINGS_FIELD_NUMBER
      See Also:
    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:
    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:
    • TESTING_OPTIONS_FIELD_NUMBER

      public static final int TESTING_OPTIONS_FIELD_NUMBER
      See Also:
    • WAF_SETTINGS_FIELD_NUMBER

      public static final int WAF_SETTINGS_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getPlatformSettingsCase

      public Key.PlatformSettingsCase getPlatformSettingsCase()
      Specified by:
      getPlatformSettingsCase in interface KeyOrBuilder
    • getName

      public String getName()
       Identifier. The resource name for the Key in the format
       `projects/{project}/keys/{key}`.
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface KeyOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name for the Key in the format
       `projects/{project}/keys/{key}`.
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface KeyOrBuilder
      Returns:
      The bytes for name.
    • getDisplayName

      public String getDisplayName()
       Required. Human-readable display name of this key. Modifiable by user.
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface KeyOrBuilder
      Returns:
      The displayName.
    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. Human-readable display name of this key. Modifiable by user.
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface KeyOrBuilder
      Returns:
      The bytes for displayName.
    • hasWebSettings

      public boolean hasWebSettings()
       Settings for keys that can be used by websites.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;
      Specified by:
      hasWebSettings in interface KeyOrBuilder
      Returns:
      Whether the webSettings field is set.
    • getWebSettings

      public WebKeySettings getWebSettings()
       Settings for keys that can be used by websites.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;
      Specified by:
      getWebSettings in interface KeyOrBuilder
      Returns:
      The webSettings.
    • getWebSettingsOrBuilder

      public WebKeySettingsOrBuilder getWebSettingsOrBuilder()
       Settings for keys that can be used by websites.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;
      Specified by:
      getWebSettingsOrBuilder in interface KeyOrBuilder
    • hasAndroidSettings

      public boolean hasAndroidSettings()
       Settings for keys that can be used by Android apps.
       
      .google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;
      Specified by:
      hasAndroidSettings in interface KeyOrBuilder
      Returns:
      Whether the androidSettings field is set.
    • getAndroidSettings

      public AndroidKeySettings getAndroidSettings()
       Settings for keys that can be used by Android apps.
       
      .google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;
      Specified by:
      getAndroidSettings in interface KeyOrBuilder
      Returns:
      The androidSettings.
    • getAndroidSettingsOrBuilder

      public AndroidKeySettingsOrBuilder getAndroidSettingsOrBuilder()
       Settings for keys that can be used by Android apps.
       
      .google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;
      Specified by:
      getAndroidSettingsOrBuilder in interface KeyOrBuilder
    • hasIosSettings

      public boolean hasIosSettings()
       Settings for keys that can be used by iOS apps.
       
      .google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;
      Specified by:
      hasIosSettings in interface KeyOrBuilder
      Returns:
      Whether the iosSettings field is set.
    • getIosSettings

      public IOSKeySettings getIosSettings()
       Settings for keys that can be used by iOS apps.
       
      .google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;
      Specified by:
      getIosSettings in interface KeyOrBuilder
      Returns:
      The iosSettings.
    • getIosSettingsOrBuilder

      public IOSKeySettingsOrBuilder getIosSettingsOrBuilder()
       Settings for keys that can be used by iOS apps.
       
      .google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;
      Specified by:
      getIosSettingsOrBuilder in interface KeyOrBuilder
    • hasExpressSettings

      public boolean hasExpressSettings()
       Settings for keys that can be used by reCAPTCHA Express.
       
      .google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;
      Specified by:
      hasExpressSettings in interface KeyOrBuilder
      Returns:
      Whether the expressSettings field is set.
    • getExpressSettings

      public ExpressKeySettings getExpressSettings()
       Settings for keys that can be used by reCAPTCHA Express.
       
      .google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;
      Specified by:
      getExpressSettings in interface KeyOrBuilder
      Returns:
      The expressSettings.
    • getExpressSettingsOrBuilder

      public ExpressKeySettingsOrBuilder getExpressSettingsOrBuilder()
       Settings for keys that can be used by reCAPTCHA Express.
       
      .google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;
      Specified by:
      getExpressSettingsOrBuilder in interface KeyOrBuilder
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: KeyOrBuilder
       Optional. See [Creating and managing labels]
       (https://cloud.google.com/recaptcha/docs/labels).
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface KeyOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       Optional. See [Creating and managing labels]
       (https://cloud.google.com/recaptcha/docs/labels).
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface KeyOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface KeyOrBuilder
    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. See [Creating and managing labels]
       (https://cloud.google.com/recaptcha/docs/labels).
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface KeyOrBuilder
    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. See [Creating and managing labels]
       (https://cloud.google.com/recaptcha/docs/labels).
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface KeyOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. See [Creating and managing labels]
       (https://cloud.google.com/recaptcha/docs/labels).
       
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface KeyOrBuilder
    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp corresponding to the creation of this key.
       
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface KeyOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp corresponding to the creation of this key.
       
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface KeyOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp corresponding to the creation of this key.
       
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface KeyOrBuilder
    • hasTestingOptions

      public boolean hasTestingOptions()
       Optional. Options for user acceptance testing.
       
      .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTestingOptions in interface KeyOrBuilder
      Returns:
      Whether the testingOptions field is set.
    • getTestingOptions

      public TestingOptions getTestingOptions()
       Optional. Options for user acceptance testing.
       
      .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTestingOptions in interface KeyOrBuilder
      Returns:
      The testingOptions.
    • getTestingOptionsOrBuilder

      public TestingOptionsOrBuilder getTestingOptionsOrBuilder()
       Optional. Options for user acceptance testing.
       
      .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTestingOptionsOrBuilder in interface KeyOrBuilder
    • hasWafSettings

      public boolean hasWafSettings()
       Optional. Settings for Web Application Firewall (WAF).
       
      .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasWafSettings in interface KeyOrBuilder
      Returns:
      Whether the wafSettings field is set.
    • getWafSettings

      public WafSettings getWafSettings()
       Optional. Settings for Web Application Firewall (WAF).
       
      .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWafSettings in interface KeyOrBuilder
      Returns:
      The wafSettings.
    • getWafSettingsOrBuilder

      public WafSettingsOrBuilder getWafSettingsOrBuilder()
       Optional. Settings for Web Application Firewall (WAF).
       
      .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWafSettingsOrBuilder in interface KeyOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static Key parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Key parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Key parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Key parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Key parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Key parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Key parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Key parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Key parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Key parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Key parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Key parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public Key.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static Key.Builder newBuilder()
    • newBuilder

      public static Key.Builder newBuilder(Key prototype)
    • toBuilder

      public Key.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected Key.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static Key getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<Key> parser()
    • getParserForType

      public com.google.protobuf.Parser<Key> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

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