1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto 18 19 package com.google.recaptchaenterprise.v1; 20 21 public interface WebKeySettingsOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.recaptchaenterprise.v1.WebKeySettings) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * If set to true, it means allowed_domains will not be enforced. 31 * </pre> 32 * 33 * <code>bool allow_all_domains = 3;</code> 34 * 35 * @return The allowAllDomains. 36 */ getAllowAllDomains()37 boolean getAllowAllDomains(); 38 39 /** 40 * 41 * 42 * <pre> 43 * Domains or subdomains of websites allowed to use the key. All subdomains 44 * of an allowed domain are automatically allowed. A valid domain requires a 45 * host and must not include any path, port, query or fragment. 46 * Examples: 'example.com' or 'subdomain.example.com' 47 * </pre> 48 * 49 * <code>repeated string allowed_domains = 1;</code> 50 * 51 * @return A list containing the allowedDomains. 52 */ getAllowedDomainsList()53 java.util.List<java.lang.String> getAllowedDomainsList(); 54 /** 55 * 56 * 57 * <pre> 58 * Domains or subdomains of websites allowed to use the key. All subdomains 59 * of an allowed domain are automatically allowed. A valid domain requires a 60 * host and must not include any path, port, query or fragment. 61 * Examples: 'example.com' or 'subdomain.example.com' 62 * </pre> 63 * 64 * <code>repeated string allowed_domains = 1;</code> 65 * 66 * @return The count of allowedDomains. 67 */ getAllowedDomainsCount()68 int getAllowedDomainsCount(); 69 /** 70 * 71 * 72 * <pre> 73 * Domains or subdomains of websites allowed to use the key. All subdomains 74 * of an allowed domain are automatically allowed. A valid domain requires a 75 * host and must not include any path, port, query or fragment. 76 * Examples: 'example.com' or 'subdomain.example.com' 77 * </pre> 78 * 79 * <code>repeated string allowed_domains = 1;</code> 80 * 81 * @param index The index of the element to return. 82 * @return The allowedDomains at the given index. 83 */ getAllowedDomains(int index)84 java.lang.String getAllowedDomains(int index); 85 /** 86 * 87 * 88 * <pre> 89 * Domains or subdomains of websites allowed to use the key. All subdomains 90 * of an allowed domain are automatically allowed. A valid domain requires a 91 * host and must not include any path, port, query or fragment. 92 * Examples: 'example.com' or 'subdomain.example.com' 93 * </pre> 94 * 95 * <code>repeated string allowed_domains = 1;</code> 96 * 97 * @param index The index of the value to return. 98 * @return The bytes of the allowedDomains at the given index. 99 */ getAllowedDomainsBytes(int index)100 com.google.protobuf.ByteString getAllowedDomainsBytes(int index); 101 102 /** 103 * 104 * 105 * <pre> 106 * If set to true, the key can be used on AMP (Accelerated Mobile Pages) 107 * websites. This is supported only for the SCORE integration type. 108 * </pre> 109 * 110 * <code>bool allow_amp_traffic = 2;</code> 111 * 112 * @return The allowAmpTraffic. 113 */ getAllowAmpTraffic()114 boolean getAllowAmpTraffic(); 115 116 /** 117 * 118 * 119 * <pre> 120 * Required. Describes how this key is integrated with the website. 121 * </pre> 122 * 123 * <code> 124 * .google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED]; 125 * </code> 126 * 127 * @return The enum numeric value on the wire for integrationType. 128 */ getIntegrationTypeValue()129 int getIntegrationTypeValue(); 130 /** 131 * 132 * 133 * <pre> 134 * Required. Describes how this key is integrated with the website. 135 * </pre> 136 * 137 * <code> 138 * .google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED]; 139 * </code> 140 * 141 * @return The integrationType. 142 */ getIntegrationType()143 com.google.recaptchaenterprise.v1.WebKeySettings.IntegrationType getIntegrationType(); 144 145 /** 146 * 147 * 148 * <pre> 149 * Settings for the frequency and difficulty at which this key triggers 150 * captcha challenges. This should only be specified for IntegrationTypes 151 * CHECKBOX and INVISIBLE. 152 * </pre> 153 * 154 * <code> 155 * .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5; 156 * </code> 157 * 158 * @return The enum numeric value on the wire for challengeSecurityPreference. 159 */ getChallengeSecurityPreferenceValue()160 int getChallengeSecurityPreferenceValue(); 161 /** 162 * 163 * 164 * <pre> 165 * Settings for the frequency and difficulty at which this key triggers 166 * captcha challenges. This should only be specified for IntegrationTypes 167 * CHECKBOX and INVISIBLE. 168 * </pre> 169 * 170 * <code> 171 * .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5; 172 * </code> 173 * 174 * @return The challengeSecurityPreference. 175 */ 176 com.google.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference getChallengeSecurityPreference()177 getChallengeSecurityPreference(); 178 } 179