diff --git a/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php b/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php index fb73b9cae59b..3777dcf19634 100644 Binary files a/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php and b/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php differ diff --git a/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/create_key.php b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/create_key.php index 4ca30880cc87..9491a9c3e64e 100644 --- a/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/create_key.php +++ b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/create_key.php @@ -33,14 +33,16 @@ * @param string $formattedParent The name of the project in which the key will be created, in the * format `projects/{project}`. Please see * {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field. + * @param string $keyDisplayName Human-readable display name of this key. Modifiable by user. */ -function create_key_sample(string $formattedParent): void +function create_key_sample(string $formattedParent, string $keyDisplayName): void { // Create a client. $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient(); // Prepare any non-scalar elements to be passed along with the request. - $key = new Key(); + $key = (new Key()) + ->setDisplayName($keyDisplayName); // Call the API and handle any network failures. try { @@ -64,7 +66,8 @@ function create_key_sample(string $formattedParent): void function callSample(): void { $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]'); + $keyDisplayName = '[DISPLAY_NAME]'; - create_key_sample($formattedParent); + create_key_sample($formattedParent, $keyDisplayName); } // [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_sync] diff --git a/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/update_key.php b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/update_key.php index 3eca748aa34a..aab6a7ea5ca5 100644 --- a/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/update_key.php +++ b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/update_key.php @@ -30,19 +30,16 @@ /** * Updates the specified key. * - * This sample has been automatically generated and should be regarded as a code - * template only. It will require modifications to work: - * - It may require correct/in-range values for request initialization. - * - It may require specifying regional endpoints when creating the service client, - * please see the apiEndpoint client configuration option for more details. + * @param string $keyDisplayName Human-readable display name of this key. Modifiable by user. */ -function update_key_sample(): void +function update_key_sample(string $keyDisplayName): void { // Create a client. $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient(); // Prepare any non-scalar elements to be passed along with the request. - $key = new Key(); + $key = (new Key()) + ->setDisplayName($keyDisplayName); // Call the API and handle any network failures. try { @@ -53,4 +50,20 @@ function update_key_sample(): void printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); } } + +/** + * Helper to execute the sample. + * + * This sample has been automatically generated and should be regarded as a code + * template only. It will require modifications to work: + * - It may require correct/in-range values for request initialization. + * - It may require specifying regional endpoints when creating the service client, + * please see the apiEndpoint client configuration option for more details. + */ +function callSample(): void +{ + $keyDisplayName = '[DISPLAY_NAME]'; + + update_key_sample($keyDisplayName); +} // [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_sync] diff --git a/RecaptchaEnterprise/src/V1/AccountDefenderAssessment.php b/RecaptchaEnterprise/src/V1/AccountDefenderAssessment.php index f0127e14b40e..a9ab1644bb8c 100644 --- a/RecaptchaEnterprise/src/V1/AccountDefenderAssessment.php +++ b/RecaptchaEnterprise/src/V1/AccountDefenderAssessment.php @@ -16,9 +16,9 @@ class AccountDefenderAssessment extends \Google\Protobuf\Internal\Message { /** - * Labels for this request. + * Output only. Labels for this request. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel labels = 1; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel labels = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $labels; @@ -29,7 +29,7 @@ class AccountDefenderAssessment extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $labels - * Labels for this request. + * Output only. Labels for this request. * } */ public function __construct($data = NULL) { @@ -38,9 +38,9 @@ public function __construct($data = NULL) { } /** - * Labels for this request. + * Output only. Labels for this request. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel labels = 1; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel labels = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getLabels() @@ -49,9 +49,9 @@ public function getLabels() } /** - * Labels for this request. + * Output only. Labels for this request. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel labels = 1; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel labels = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/AccountVerificationInfo.php b/RecaptchaEnterprise/src/V1/AccountVerificationInfo.php index bdffc4af6357..9c631909c449 100644 --- a/RecaptchaEnterprise/src/V1/AccountVerificationInfo.php +++ b/RecaptchaEnterprise/src/V1/AccountVerificationInfo.php @@ -16,16 +16,16 @@ class AccountVerificationInfo extends \Google\Protobuf\Internal\Message { /** - * Endpoints that can be used for identity verification. + * Optional. Endpoints that can be used for identity verification. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo endpoints = 1; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo endpoints = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $endpoints; /** - * Language code preference for the verification message, set as a IETF BCP 47 - * language code. + * Optional. Language code preference for the verification message, set as a + * IETF BCP 47 language code. * - * Generated from protobuf field string language_code = 3; + * Generated from protobuf field string language_code = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $language_code = ''; /** @@ -50,10 +50,10 @@ class AccountVerificationInfo extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\RecaptchaEnterprise\V1\EndpointVerificationInfo>|\Google\Protobuf\Internal\RepeatedField $endpoints - * Endpoints that can be used for identity verification. + * Optional. Endpoints that can be used for identity verification. * @type string $language_code - * Language code preference for the verification message, set as a IETF BCP 47 - * language code. + * Optional. Language code preference for the verification message, set as a + * IETF BCP 47 language code. * @type int $latest_verification_result * Output only. Result of the latest account verification challenge. * @type string $username @@ -67,9 +67,9 @@ public function __construct($data = NULL) { } /** - * Endpoints that can be used for identity verification. + * Optional. Endpoints that can be used for identity verification. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo endpoints = 1; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo endpoints = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getEndpoints() @@ -78,9 +78,9 @@ public function getEndpoints() } /** - * Endpoints that can be used for identity verification. + * Optional. Endpoints that can be used for identity verification. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo endpoints = 1; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo endpoints = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\RecaptchaEnterprise\V1\EndpointVerificationInfo>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -93,10 +93,10 @@ public function setEndpoints($var) } /** - * Language code preference for the verification message, set as a IETF BCP 47 - * language code. + * Optional. Language code preference for the verification message, set as a + * IETF BCP 47 language code. * - * Generated from protobuf field string language_code = 3; + * Generated from protobuf field string language_code = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getLanguageCode() @@ -105,10 +105,10 @@ public function getLanguageCode() } /** - * Language code preference for the verification message, set as a IETF BCP 47 - * language code. + * Optional. Language code preference for the verification message, set as a + * IETF BCP 47 language code. * - * Generated from protobuf field string language_code = 3; + * Generated from protobuf field string language_code = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/AndroidKeySettings.php b/RecaptchaEnterprise/src/V1/AndroidKeySettings.php index caa6d695edf4..67b074a69f36 100644 --- a/RecaptchaEnterprise/src/V1/AndroidKeySettings.php +++ b/RecaptchaEnterprise/src/V1/AndroidKeySettings.php @@ -16,23 +16,24 @@ class AndroidKeySettings extends \Google\Protobuf\Internal\Message { /** - * If set to true, allowed_package_names are not enforced. + * Optional. If set to true, allowed_package_names are not enforced. * - * Generated from protobuf field bool allow_all_package_names = 2; + * Generated from protobuf field bool allow_all_package_names = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $allow_all_package_names = false; /** - * Android package names of apps allowed to use the key. + * Optional. Android package names of apps allowed to use the key. * Example: 'com.companyname.appname' * - * Generated from protobuf field repeated string allowed_package_names = 1; + * Generated from protobuf field repeated string allowed_package_names = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $allowed_package_names; /** - * Set to true for keys that are used in an Android application that is - * available for download in app stores in addition to the Google Play Store. + * Optional. Set to true for keys that are used in an Android application that + * is available for download in app stores in addition to the Google Play + * Store. * - * Generated from protobuf field bool support_non_google_app_store_distribution = 3; + * Generated from protobuf field bool support_non_google_app_store_distribution = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $support_non_google_app_store_distribution = false; @@ -43,13 +44,14 @@ class AndroidKeySettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $allow_all_package_names - * If set to true, allowed_package_names are not enforced. + * Optional. If set to true, allowed_package_names are not enforced. * @type array|\Google\Protobuf\Internal\RepeatedField $allowed_package_names - * Android package names of apps allowed to use the key. + * Optional. Android package names of apps allowed to use the key. * Example: 'com.companyname.appname' * @type bool $support_non_google_app_store_distribution - * Set to true for keys that are used in an Android application that is - * available for download in app stores in addition to the Google Play Store. + * Optional. Set to true for keys that are used in an Android application that + * is available for download in app stores in addition to the Google Play + * Store. * } */ public function __construct($data = NULL) { @@ -58,9 +60,9 @@ public function __construct($data = NULL) { } /** - * If set to true, allowed_package_names are not enforced. + * Optional. If set to true, allowed_package_names are not enforced. * - * Generated from protobuf field bool allow_all_package_names = 2; + * Generated from protobuf field bool allow_all_package_names = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getAllowAllPackageNames() @@ -69,9 +71,9 @@ public function getAllowAllPackageNames() } /** - * If set to true, allowed_package_names are not enforced. + * Optional. If set to true, allowed_package_names are not enforced. * - * Generated from protobuf field bool allow_all_package_names = 2; + * Generated from protobuf field bool allow_all_package_names = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -84,10 +86,10 @@ public function setAllowAllPackageNames($var) } /** - * Android package names of apps allowed to use the key. + * Optional. Android package names of apps allowed to use the key. * Example: 'com.companyname.appname' * - * Generated from protobuf field repeated string allowed_package_names = 1; + * Generated from protobuf field repeated string allowed_package_names = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAllowedPackageNames() @@ -96,10 +98,10 @@ public function getAllowedPackageNames() } /** - * Android package names of apps allowed to use the key. + * Optional. Android package names of apps allowed to use the key. * Example: 'com.companyname.appname' * - * Generated from protobuf field repeated string allowed_package_names = 1; + * Generated from protobuf field repeated string allowed_package_names = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -112,10 +114,11 @@ public function setAllowedPackageNames($var) } /** - * Set to true for keys that are used in an Android application that is - * available for download in app stores in addition to the Google Play Store. + * Optional. Set to true for keys that are used in an Android application that + * is available for download in app stores in addition to the Google Play + * Store. * - * Generated from protobuf field bool support_non_google_app_store_distribution = 3; + * Generated from protobuf field bool support_non_google_app_store_distribution = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getSupportNonGoogleAppStoreDistribution() @@ -124,10 +127,11 @@ public function getSupportNonGoogleAppStoreDistribution() } /** - * Set to true for keys that are used in an Android application that is - * available for download in app stores in addition to the Google Play Store. + * Optional. Set to true for keys that are used in an Android application that + * is available for download in app stores in addition to the Google Play + * Store. * - * Generated from protobuf field bool support_non_google_app_store_distribution = 3; + * Generated from protobuf field bool support_non_google_app_store_distribution = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/Assessment.php b/RecaptchaEnterprise/src/V1/Assessment.php index 10f4781a8549..13f7beee7551 100644 --- a/RecaptchaEnterprise/src/V1/Assessment.php +++ b/RecaptchaEnterprise/src/V1/Assessment.php @@ -23,9 +23,9 @@ class Assessment extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * The event being assessed. + * Optional. The event being assessed. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Event event = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $event = null; /** @@ -41,37 +41,39 @@ class Assessment extends \Google\Protobuf\Internal\Message */ private $token_properties = null; /** - * Account verification information for identity verification. The assessment - * event must include a token and site key to use this feature. + * Optional. Account verification information for identity verification. The + * assessment event must include a token and site key to use this feature. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $account_verification = null; /** - * Assessment returned by account defender when a hashed_account_id is - * provided. + * Output only. Assessment returned by account defender when a + * hashed_account_id is provided. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $account_defender_assessment = null; /** - * The private password leak verification field contains the parameters that - * are used to to check for leaks privately without sharing user credentials. + * Optional. The private password leak verification field contains the + * parameters that are used to to check for leaks privately without sharing + * user credentials. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL]; */ private $private_password_leak_verification = null; /** - * Assessment returned when firewall policies belonging to the project are - * evaluated using the field firewall_policy_evaluation. + * Output only. Assessment returned when firewall policies belonging to the + * project are evaluated using the field firewall_policy_evaluation. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $firewall_policy_assessment = null; /** - * Assessment returned by Fraud Prevention when TransactionData is provided. + * Output only. Assessment returned by Fraud Prevention when TransactionData + * is provided. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $fraud_prevention_assessment = null; /** @@ -92,25 +94,27 @@ class Assessment extends \Google\Protobuf\Internal\Message * Output only. The resource name for the Assessment in the format * `projects/{project}/assessments/{assessment}`. * @type \Google\Cloud\RecaptchaEnterprise\V1\Event $event - * The event being assessed. + * Optional. The event being assessed. * @type \Google\Cloud\RecaptchaEnterprise\V1\RiskAnalysis $risk_analysis * Output only. The risk analysis result for the event being assessed. * @type \Google\Cloud\RecaptchaEnterprise\V1\TokenProperties $token_properties * Output only. Properties of the provided event token. * @type \Google\Cloud\RecaptchaEnterprise\V1\AccountVerificationInfo $account_verification - * Account verification information for identity verification. The assessment - * event must include a token and site key to use this feature. + * Optional. Account verification information for identity verification. The + * assessment event must include a token and site key to use this feature. * @type \Google\Cloud\RecaptchaEnterprise\V1\AccountDefenderAssessment $account_defender_assessment - * Assessment returned by account defender when a hashed_account_id is - * provided. + * Output only. Assessment returned by account defender when a + * hashed_account_id is provided. * @type \Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification $private_password_leak_verification - * The private password leak verification field contains the parameters that - * are used to to check for leaks privately without sharing user credentials. + * Optional. The private password leak verification field contains the + * parameters that are used to to check for leaks privately without sharing + * user credentials. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicyAssessment $firewall_policy_assessment - * Assessment returned when firewall policies belonging to the project are - * evaluated using the field firewall_policy_evaluation. + * Output only. Assessment returned when firewall policies belonging to the + * project are evaluated using the field firewall_policy_evaluation. * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment $fraud_prevention_assessment - * Assessment returned by Fraud Prevention when TransactionData is provided. + * Output only. Assessment returned by Fraud Prevention when TransactionData + * is provided. * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudSignals $fraud_signals * Output only. Fraud Signals specific to the users involved in a payment * transaction. @@ -150,9 +154,9 @@ public function setName($var) } /** - * The event being assessed. + * Optional. The event being assessed. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Event event = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\Event|null */ public function getEvent() @@ -171,9 +175,9 @@ public function clearEvent() } /** - * The event being assessed. + * Optional. The event being assessed. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Event event = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\Event $var * @return $this */ @@ -258,10 +262,10 @@ public function setTokenProperties($var) } /** - * Account verification information for identity verification. The assessment - * event must include a token and site key to use this feature. + * Optional. Account verification information for identity verification. The + * assessment event must include a token and site key to use this feature. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\AccountVerificationInfo|null */ public function getAccountVerification() @@ -280,10 +284,10 @@ public function clearAccountVerification() } /** - * Account verification information for identity verification. The assessment - * event must include a token and site key to use this feature. + * Optional. Account verification information for identity verification. The + * assessment event must include a token and site key to use this feature. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\AccountVerificationInfo $var * @return $this */ @@ -296,10 +300,10 @@ public function setAccountVerification($var) } /** - * Assessment returned by account defender when a hashed_account_id is - * provided. + * Output only. Assessment returned by account defender when a + * hashed_account_id is provided. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\RecaptchaEnterprise\V1\AccountDefenderAssessment|null */ public function getAccountDefenderAssessment() @@ -318,10 +322,10 @@ public function clearAccountDefenderAssessment() } /** - * Assessment returned by account defender when a hashed_account_id is - * provided. + * Output only. Assessment returned by account defender when a + * hashed_account_id is provided. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\RecaptchaEnterprise\V1\AccountDefenderAssessment $var * @return $this */ @@ -334,10 +338,11 @@ public function setAccountDefenderAssessment($var) } /** - * The private password leak verification field contains the parameters that - * are used to to check for leaks privately without sharing user credentials. + * Optional. The private password leak verification field contains the + * parameters that are used to to check for leaks privately without sharing + * user credentials. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification|null */ public function getPrivatePasswordLeakVerification() @@ -356,10 +361,11 @@ public function clearPrivatePasswordLeakVerification() } /** - * The private password leak verification field contains the parameters that - * are used to to check for leaks privately without sharing user credentials. + * Optional. The private password leak verification field contains the + * parameters that are used to to check for leaks privately without sharing + * user credentials. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification $var * @return $this */ @@ -372,10 +378,10 @@ public function setPrivatePasswordLeakVerification($var) } /** - * Assessment returned when firewall policies belonging to the project are - * evaluated using the field firewall_policy_evaluation. + * Output only. Assessment returned when firewall policies belonging to the + * project are evaluated using the field firewall_policy_evaluation. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicyAssessment|null */ public function getFirewallPolicyAssessment() @@ -394,10 +400,10 @@ public function clearFirewallPolicyAssessment() } /** - * Assessment returned when firewall policies belonging to the project are - * evaluated using the field firewall_policy_evaluation. + * Output only. Assessment returned when firewall policies belonging to the + * project are evaluated using the field firewall_policy_evaluation. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicyAssessment $var * @return $this */ @@ -410,9 +416,10 @@ public function setFirewallPolicyAssessment($var) } /** - * Assessment returned by Fraud Prevention when TransactionData is provided. + * Output only. Assessment returned by Fraud Prevention when TransactionData + * is provided. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment|null */ public function getFraudPreventionAssessment() @@ -431,9 +438,10 @@ public function clearFraudPreventionAssessment() } /** - * Assessment returned by Fraud Prevention when TransactionData is provided. + * Output only. Assessment returned by Fraud Prevention when TransactionData + * is provided. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/Event.php b/RecaptchaEnterprise/src/V1/Event.php index f85e5443e8a3..763519875afd 100644 --- a/RecaptchaEnterprise/src/V1/Event.php +++ b/RecaptchaEnterprise/src/V1/Event.php @@ -81,7 +81,7 @@ class Event extends \Google\Protobuf\Internal\Message */ private $waf_token_assessment = false; /** - * Optional. Optional JA3 fingerprint for SSL clients. + * Optional. JA3 fingerprint for SSL clients. * * Generated from protobuf field string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -145,7 +145,7 @@ class Event extends \Google\Protobuf\Internal\Message * If enabled, the token must be specified, and have been created by a * WAF-enabled key. * @type string $ja3 - * Optional. Optional JA3 fingerprint for SSL clients. + * Optional. JA3 fingerprint for SSL clients. * @type array|\Google\Protobuf\Internal\RepeatedField $headers * Optional. HTTP header information about the request. * @type bool $firewall_policy_evaluation @@ -420,7 +420,7 @@ public function setWafTokenAssessment($var) } /** - * Optional. Optional JA3 fingerprint for SSL clients. + * Optional. JA3 fingerprint for SSL clients. * * Generated from protobuf field string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -431,7 +431,7 @@ public function getJa3() } /** - * Optional. Optional JA3 fingerprint for SSL clients. + * Optional. JA3 fingerprint for SSL clients. * * Generated from protobuf field string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/RecaptchaEnterprise/src/V1/FirewallAction/SetHeaderAction.php b/RecaptchaEnterprise/src/V1/FirewallAction/SetHeaderAction.php index 78b9409cc827..5015a45b4e99 100644 --- a/RecaptchaEnterprise/src/V1/FirewallAction/SetHeaderAction.php +++ b/RecaptchaEnterprise/src/V1/FirewallAction/SetHeaderAction.php @@ -18,15 +18,15 @@ class SetHeaderAction extends \Google\Protobuf\Internal\Message { /** - * The header key to set in the request to the backend server. + * Optional. The header key to set in the request to the backend server. * - * Generated from protobuf field string key = 1; + * Generated from protobuf field string key = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $key = ''; /** - * The header value to set in the request to the backend server. + * Optional. The header value to set in the request to the backend server. * - * Generated from protobuf field string value = 2; + * Generated from protobuf field string value = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $value = ''; @@ -37,9 +37,9 @@ class SetHeaderAction extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $key - * The header key to set in the request to the backend server. + * Optional. The header key to set in the request to the backend server. * @type string $value - * The header value to set in the request to the backend server. + * Optional. The header value to set in the request to the backend server. * } */ public function __construct($data = NULL) { @@ -48,9 +48,9 @@ public function __construct($data = NULL) { } /** - * The header key to set in the request to the backend server. + * Optional. The header key to set in the request to the backend server. * - * Generated from protobuf field string key = 1; + * Generated from protobuf field string key = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getKey() @@ -59,9 +59,9 @@ public function getKey() } /** - * The header key to set in the request to the backend server. + * Optional. The header key to set in the request to the backend server. * - * Generated from protobuf field string key = 1; + * Generated from protobuf field string key = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -74,9 +74,9 @@ public function setKey($var) } /** - * The header value to set in the request to the backend server. + * Optional. The header value to set in the request to the backend server. * - * Generated from protobuf field string value = 2; + * Generated from protobuf field string value = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getValue() @@ -85,9 +85,9 @@ public function getValue() } /** - * The header value to set in the request to the backend server. + * Optional. The header value to set in the request to the backend server. * - * Generated from protobuf field string value = 2; + * Generated from protobuf field string value = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/FirewallAction/SubstituteAction.php b/RecaptchaEnterprise/src/V1/FirewallAction/SubstituteAction.php index 0eafd65aaceb..02639a1b1a2c 100644 --- a/RecaptchaEnterprise/src/V1/FirewallAction/SubstituteAction.php +++ b/RecaptchaEnterprise/src/V1/FirewallAction/SubstituteAction.php @@ -17,10 +17,10 @@ class SubstituteAction extends \Google\Protobuf\Internal\Message { /** - * The address to redirect to. The target is a relative path in the - * current host. Example: "/blog/404.html". + * Optional. The address to redirect to. The target is a relative path in + * the current host. Example: "/blog/404.html". * - * Generated from protobuf field string path = 1; + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $path = ''; @@ -31,8 +31,8 @@ class SubstituteAction extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $path - * The address to redirect to. The target is a relative path in the - * current host. Example: "/blog/404.html". + * Optional. The address to redirect to. The target is a relative path in + * the current host. Example: "/blog/404.html". * } */ public function __construct($data = NULL) { @@ -41,10 +41,10 @@ public function __construct($data = NULL) { } /** - * The address to redirect to. The target is a relative path in the - * current host. Example: "/blog/404.html". + * Optional. The address to redirect to. The target is a relative path in + * the current host. Example: "/blog/404.html". * - * Generated from protobuf field string path = 1; + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPath() @@ -53,10 +53,10 @@ public function getPath() } /** - * The address to redirect to. The target is a relative path in the - * current host. Example: "/blog/404.html". + * Optional. The address to redirect to. The target is a relative path in + * the current host. Example: "/blog/404.html". * - * Generated from protobuf field string path = 1; + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/FirewallPolicy.php b/RecaptchaEnterprise/src/V1/FirewallPolicy.php index f09ac473def6..7309e32f820f 100644 --- a/RecaptchaEnterprise/src/V1/FirewallPolicy.php +++ b/RecaptchaEnterprise/src/V1/FirewallPolicy.php @@ -24,43 +24,45 @@ class FirewallPolicy extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * A description of what this policy aims to achieve, for convenience - * purposes. The description can at most include 256 UTF-8 characters. + * Optional. A description of what this policy aims to achieve, for + * convenience purposes. The description can at most include 256 UTF-8 + * characters. * - * Generated from protobuf field string description = 2; + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $description = ''; /** - * The path for which this policy applies, specified as a glob pattern. - * For more information on glob, see the [manual + * Optional. The path for which this policy applies, specified as a glob + * pattern. For more information on glob, see the [manual * page](https://man7.org/linux/man-pages/man7/glob.7.html). * A path has a max length of 200 characters. * - * Generated from protobuf field string path = 4; + * Generated from protobuf field string path = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $path = ''; /** - * A CEL (Common Expression Language) conditional expression that specifies if - * this policy applies to an incoming user request. If this condition - * evaluates to true and the requested path matched the path pattern, the - * associated actions should be executed by the caller. The condition string - * is checked for CEL syntax correctness on creation. For more information, - * see the [CEL spec](https://github.com/google/cel-spec) and its [language + * Optional. A CEL (Common Expression Language) conditional expression that + * specifies if this policy applies to an incoming user request. If this + * condition evaluates to true and the requested path matched the path + * pattern, the associated actions should be executed by the caller. The + * condition string is checked for CEL syntax correctness on creation. For + * more information, see the [CEL spec](https://github.com/google/cel-spec) + * and its [language * definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). * A condition has a max length of 500 characters. * - * Generated from protobuf field string condition = 5; + * Generated from protobuf field string condition = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $condition = ''; /** - * The actions that the caller should take regarding user access. + * Optional. The actions that the caller should take regarding user access. * There should be at most one terminal action. A terminal action is any * action that forces a response, such as `AllowAction`, * `BlockAction` or `SubstituteAction`. * Zero or more non-terminal actions such as `SetHeader` might be * specified. A single policy can contain up to 16 actions. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $actions; @@ -74,24 +76,26 @@ class FirewallPolicy extends \Google\Protobuf\Internal\Message * The resource name for the FirewallPolicy in the format * `projects/{project}/firewallpolicies/{firewallpolicy}`. * @type string $description - * A description of what this policy aims to achieve, for convenience - * purposes. The description can at most include 256 UTF-8 characters. + * Optional. A description of what this policy aims to achieve, for + * convenience purposes. The description can at most include 256 UTF-8 + * characters. * @type string $path - * The path for which this policy applies, specified as a glob pattern. - * For more information on glob, see the [manual + * Optional. The path for which this policy applies, specified as a glob + * pattern. For more information on glob, see the [manual * page](https://man7.org/linux/man-pages/man7/glob.7.html). * A path has a max length of 200 characters. * @type string $condition - * A CEL (Common Expression Language) conditional expression that specifies if - * this policy applies to an incoming user request. If this condition - * evaluates to true and the requested path matched the path pattern, the - * associated actions should be executed by the caller. The condition string - * is checked for CEL syntax correctness on creation. For more information, - * see the [CEL spec](https://github.com/google/cel-spec) and its [language + * Optional. A CEL (Common Expression Language) conditional expression that + * specifies if this policy applies to an incoming user request. If this + * condition evaluates to true and the requested path matched the path + * pattern, the associated actions should be executed by the caller. The + * condition string is checked for CEL syntax correctness on creation. For + * more information, see the [CEL spec](https://github.com/google/cel-spec) + * and its [language * definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). * A condition has a max length of 500 characters. * @type array<\Google\Cloud\RecaptchaEnterprise\V1\FirewallAction>|\Google\Protobuf\Internal\RepeatedField $actions - * The actions that the caller should take regarding user access. + * Optional. The actions that the caller should take regarding user access. * There should be at most one terminal action. A terminal action is any * action that forces a response, such as `AllowAction`, * `BlockAction` or `SubstituteAction`. @@ -133,10 +137,11 @@ public function setName($var) } /** - * A description of what this policy aims to achieve, for convenience - * purposes. The description can at most include 256 UTF-8 characters. + * Optional. A description of what this policy aims to achieve, for + * convenience purposes. The description can at most include 256 UTF-8 + * characters. * - * Generated from protobuf field string description = 2; + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getDescription() @@ -145,10 +150,11 @@ public function getDescription() } /** - * A description of what this policy aims to achieve, for convenience - * purposes. The description can at most include 256 UTF-8 characters. + * Optional. A description of what this policy aims to achieve, for + * convenience purposes. The description can at most include 256 UTF-8 + * characters. * - * Generated from protobuf field string description = 2; + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -161,12 +167,12 @@ public function setDescription($var) } /** - * The path for which this policy applies, specified as a glob pattern. - * For more information on glob, see the [manual + * Optional. The path for which this policy applies, specified as a glob + * pattern. For more information on glob, see the [manual * page](https://man7.org/linux/man-pages/man7/glob.7.html). * A path has a max length of 200 characters. * - * Generated from protobuf field string path = 4; + * Generated from protobuf field string path = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPath() @@ -175,12 +181,12 @@ public function getPath() } /** - * The path for which this policy applies, specified as a glob pattern. - * For more information on glob, see the [manual + * Optional. The path for which this policy applies, specified as a glob + * pattern. For more information on glob, see the [manual * page](https://man7.org/linux/man-pages/man7/glob.7.html). * A path has a max length of 200 characters. * - * Generated from protobuf field string path = 4; + * Generated from protobuf field string path = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -193,16 +199,17 @@ public function setPath($var) } /** - * A CEL (Common Expression Language) conditional expression that specifies if - * this policy applies to an incoming user request. If this condition - * evaluates to true and the requested path matched the path pattern, the - * associated actions should be executed by the caller. The condition string - * is checked for CEL syntax correctness on creation. For more information, - * see the [CEL spec](https://github.com/google/cel-spec) and its [language + * Optional. A CEL (Common Expression Language) conditional expression that + * specifies if this policy applies to an incoming user request. If this + * condition evaluates to true and the requested path matched the path + * pattern, the associated actions should be executed by the caller. The + * condition string is checked for CEL syntax correctness on creation. For + * more information, see the [CEL spec](https://github.com/google/cel-spec) + * and its [language * definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). * A condition has a max length of 500 characters. * - * Generated from protobuf field string condition = 5; + * Generated from protobuf field string condition = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getCondition() @@ -211,16 +218,17 @@ public function getCondition() } /** - * A CEL (Common Expression Language) conditional expression that specifies if - * this policy applies to an incoming user request. If this condition - * evaluates to true and the requested path matched the path pattern, the - * associated actions should be executed by the caller. The condition string - * is checked for CEL syntax correctness on creation. For more information, - * see the [CEL spec](https://github.com/google/cel-spec) and its [language + * Optional. A CEL (Common Expression Language) conditional expression that + * specifies if this policy applies to an incoming user request. If this + * condition evaluates to true and the requested path matched the path + * pattern, the associated actions should be executed by the caller. The + * condition string is checked for CEL syntax correctness on creation. For + * more information, see the [CEL spec](https://github.com/google/cel-spec) + * and its [language * definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). * A condition has a max length of 500 characters. * - * Generated from protobuf field string condition = 5; + * Generated from protobuf field string condition = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -233,14 +241,14 @@ public function setCondition($var) } /** - * The actions that the caller should take regarding user access. + * Optional. The actions that the caller should take regarding user access. * There should be at most one terminal action. A terminal action is any * action that forces a response, such as `AllowAction`, * `BlockAction` or `SubstituteAction`. * Zero or more non-terminal actions such as `SetHeader` might be * specified. A single policy can contain up to 16 actions. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getActions() @@ -249,14 +257,14 @@ public function getActions() } /** - * The actions that the caller should take regarding user access. + * Optional. The actions that the caller should take regarding user access. * There should be at most one terminal action. A terminal action is any * action that forces a response, such as `AllowAction`, * `BlockAction` or `SubstituteAction`. * Zero or more non-terminal actions such as `SetHeader` might be * specified. A single policy can contain up to 16 actions. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\RecaptchaEnterprise\V1\FirewallAction>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/FirewallPolicyAssessment.php b/RecaptchaEnterprise/src/V1/FirewallPolicyAssessment.php index 5292d4661b1b..24ee0a582a5e 100644 --- a/RecaptchaEnterprise/src/V1/FirewallPolicyAssessment.php +++ b/RecaptchaEnterprise/src/V1/FirewallPolicyAssessment.php @@ -16,10 +16,10 @@ class FirewallPolicyAssessment extends \Google\Protobuf\Internal\Message { /** - * If the processing of a policy config fails, an error will be populated - * and the firewall_policy will be left empty. + * Output only. If the processing of a policy config fails, an error will be + * populated and the firewall_policy will be left empty. * - * Generated from protobuf field .google.rpc.Status error = 5; + * Generated from protobuf field .google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $error = null; /** @@ -38,8 +38,8 @@ class FirewallPolicyAssessment extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Rpc\Status $error - * If the processing of a policy config fails, an error will be populated - * and the firewall_policy will be left empty. + * Output only. If the processing of a policy config fails, an error will be + * populated and the firewall_policy will be left empty. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy $firewall_policy * Output only. The policy that matched the request. If more than one policy * may match, this is the first match. If no policy matches the incoming @@ -52,10 +52,10 @@ public function __construct($data = NULL) { } /** - * If the processing of a policy config fails, an error will be populated - * and the firewall_policy will be left empty. + * Output only. If the processing of a policy config fails, an error will be + * populated and the firewall_policy will be left empty. * - * Generated from protobuf field .google.rpc.Status error = 5; + * Generated from protobuf field .google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Rpc\Status|null */ public function getError() @@ -74,10 +74,10 @@ public function clearError() } /** - * If the processing of a policy config fails, an error will be populated - * and the firewall_policy will be left empty. + * Output only. If the processing of a policy config fails, an error will be + * populated and the firewall_policy will be left empty. * - * Generated from protobuf field .google.rpc.Status error = 5; + * Generated from protobuf field .google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Rpc\Status $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php index 5e7bd63e3ace..e85ac2555482 100644 --- a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php @@ -16,30 +16,31 @@ class FraudPreventionAssessment extends \Google\Protobuf\Internal\Message { /** - * Probability of this transaction being fraudulent. Summarizes the combined - * risk of attack vectors below. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being fraudulent. Summarizes + * the combined risk of attack vectors below. Values are from 0.0 (lowest) + * to 1.0 (highest). * - * Generated from protobuf field float transaction_risk = 1; + * Generated from protobuf field float transaction_risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $transaction_risk = 0.0; /** - * Assessment of this transaction for risk of a stolen instrument. + * Output only. Assessment of this transaction for risk of a stolen + * instrument. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $stolen_instrument_verdict = null; /** - * Assessment of this transaction for risk of being part of a card testing - * attack. + * Output only. Assessment of this transaction for risk of being part of a + * card testing attack. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $card_testing_verdict = null; /** - * Assessment of this transaction for behavioral trust. + * Output only. Assessment of this transaction for behavioral trust. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.BehavioralTrustVerdict behavioral_trust_verdict = 4; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.BehavioralTrustVerdict behavioral_trust_verdict = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $behavioral_trust_verdict = null; @@ -50,16 +51,17 @@ class FraudPreventionAssessment extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $transaction_risk - * Probability of this transaction being fraudulent. Summarizes the combined - * risk of attack vectors below. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being fraudulent. Summarizes + * the combined risk of attack vectors below. Values are from 0.0 (lowest) + * to 1.0 (highest). * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\StolenInstrumentVerdict $stolen_instrument_verdict - * Assessment of this transaction for risk of a stolen instrument. + * Output only. Assessment of this transaction for risk of a stolen + * instrument. * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\CardTestingVerdict $card_testing_verdict - * Assessment of this transaction for risk of being part of a card testing - * attack. + * Output only. Assessment of this transaction for risk of being part of a + * card testing attack. * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\BehavioralTrustVerdict $behavioral_trust_verdict - * Assessment of this transaction for behavioral trust. + * Output only. Assessment of this transaction for behavioral trust. * } */ public function __construct($data = NULL) { @@ -68,11 +70,11 @@ public function __construct($data = NULL) { } /** - * Probability of this transaction being fraudulent. Summarizes the combined - * risk of attack vectors below. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being fraudulent. Summarizes + * the combined risk of attack vectors below. Values are from 0.0 (lowest) + * to 1.0 (highest). * - * Generated from protobuf field float transaction_risk = 1; + * Generated from protobuf field float transaction_risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return float */ public function getTransactionRisk() @@ -81,11 +83,11 @@ public function getTransactionRisk() } /** - * Probability of this transaction being fraudulent. Summarizes the combined - * risk of attack vectors below. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being fraudulent. Summarizes + * the combined risk of attack vectors below. Values are from 0.0 (lowest) + * to 1.0 (highest). * - * Generated from protobuf field float transaction_risk = 1; + * Generated from protobuf field float transaction_risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param float $var * @return $this */ @@ -98,9 +100,10 @@ public function setTransactionRisk($var) } /** - * Assessment of this transaction for risk of a stolen instrument. + * Output only. Assessment of this transaction for risk of a stolen + * instrument. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\StolenInstrumentVerdict|null */ public function getStolenInstrumentVerdict() @@ -119,9 +122,10 @@ public function clearStolenInstrumentVerdict() } /** - * Assessment of this transaction for risk of a stolen instrument. + * Output only. Assessment of this transaction for risk of a stolen + * instrument. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\StolenInstrumentVerdict $var * @return $this */ @@ -134,10 +138,10 @@ public function setStolenInstrumentVerdict($var) } /** - * Assessment of this transaction for risk of being part of a card testing - * attack. + * Output only. Assessment of this transaction for risk of being part of a + * card testing attack. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\CardTestingVerdict|null */ public function getCardTestingVerdict() @@ -156,10 +160,10 @@ public function clearCardTestingVerdict() } /** - * Assessment of this transaction for risk of being part of a card testing - * attack. + * Output only. Assessment of this transaction for risk of being part of a + * card testing attack. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\CardTestingVerdict $var * @return $this */ @@ -172,9 +176,9 @@ public function setCardTestingVerdict($var) } /** - * Assessment of this transaction for behavioral trust. + * Output only. Assessment of this transaction for behavioral trust. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.BehavioralTrustVerdict behavioral_trust_verdict = 4; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.BehavioralTrustVerdict behavioral_trust_verdict = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\BehavioralTrustVerdict|null */ public function getBehavioralTrustVerdict() @@ -193,9 +197,9 @@ public function clearBehavioralTrustVerdict() } /** - * Assessment of this transaction for behavioral trust. + * Output only. Assessment of this transaction for behavioral trust. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.BehavioralTrustVerdict behavioral_trust_verdict = 4; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.BehavioralTrustVerdict behavioral_trust_verdict = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\BehavioralTrustVerdict $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/BehavioralTrustVerdict.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/BehavioralTrustVerdict.php index bebd7270e8b9..c8881275b303 100644 --- a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/BehavioralTrustVerdict.php +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/BehavioralTrustVerdict.php @@ -16,11 +16,11 @@ class BehavioralTrustVerdict extends \Google\Protobuf\Internal\Message { /** - * Probability of this transaction attempt being executed in a behaviorally - * trustworthy way. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being executed in a + * behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0 + * (highest). * - * Generated from protobuf field float trust = 1; + * Generated from protobuf field float trust = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $trust = 0.0; @@ -31,9 +31,9 @@ class BehavioralTrustVerdict extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $trust - * Probability of this transaction attempt being executed in a behaviorally - * trustworthy way. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being executed in a + * behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0 + * (highest). * } */ public function __construct($data = NULL) { @@ -42,11 +42,11 @@ public function __construct($data = NULL) { } /** - * Probability of this transaction attempt being executed in a behaviorally - * trustworthy way. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being executed in a + * behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0 + * (highest). * - * Generated from protobuf field float trust = 1; + * Generated from protobuf field float trust = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return float */ public function getTrust() @@ -55,11 +55,11 @@ public function getTrust() } /** - * Probability of this transaction attempt being executed in a behaviorally - * trustworthy way. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being executed in a + * behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0 + * (highest). * - * Generated from protobuf field float trust = 1; + * Generated from protobuf field float trust = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param float $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php index e540829398ba..8de3be9da216 100644 --- a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php @@ -17,11 +17,10 @@ class CardTestingVerdict extends \Google\Protobuf\Internal\Message { /** - * Probability of this transaction attempt being part of a card testing - * attack. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being part of a card + * testing attack. Values are from 0.0 (lowest) to 1.0 (highest). * - * Generated from protobuf field float risk = 1; + * Generated from protobuf field float risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $risk = 0.0; @@ -32,9 +31,8 @@ class CardTestingVerdict extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $risk - * Probability of this transaction attempt being part of a card testing - * attack. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being part of a card + * testing attack. Values are from 0.0 (lowest) to 1.0 (highest). * } */ public function __construct($data = NULL) { @@ -43,11 +41,10 @@ public function __construct($data = NULL) { } /** - * Probability of this transaction attempt being part of a card testing - * attack. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being part of a card + * testing attack. Values are from 0.0 (lowest) to 1.0 (highest). * - * Generated from protobuf field float risk = 1; + * Generated from protobuf field float risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return float */ public function getRisk() @@ -56,11 +53,10 @@ public function getRisk() } /** - * Probability of this transaction attempt being part of a card testing - * attack. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction attempt being part of a card + * testing attack. Values are from 0.0 (lowest) to 1.0 (highest). * - * Generated from protobuf field float risk = 1; + * Generated from protobuf field float risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param float $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php index ce29a1c5e7c8..e16e5205d8b0 100644 --- a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php @@ -17,10 +17,10 @@ class StolenInstrumentVerdict extends \Google\Protobuf\Internal\Message { /** - * Probability of this transaction being executed with a stolen instrument. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being executed with a stolen + * instrument. Values are from 0.0 (lowest) to 1.0 (highest). * - * Generated from protobuf field float risk = 1; + * Generated from protobuf field float risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $risk = 0.0; @@ -31,8 +31,8 @@ class StolenInstrumentVerdict extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $risk - * Probability of this transaction being executed with a stolen instrument. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being executed with a stolen + * instrument. Values are from 0.0 (lowest) to 1.0 (highest). * } */ public function __construct($data = NULL) { @@ -41,10 +41,10 @@ public function __construct($data = NULL) { } /** - * Probability of this transaction being executed with a stolen instrument. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being executed with a stolen + * instrument. Values are from 0.0 (lowest) to 1.0 (highest). * - * Generated from protobuf field float risk = 1; + * Generated from protobuf field float risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return float */ public function getRisk() @@ -53,10 +53,10 @@ public function getRisk() } /** - * Probability of this transaction being executed with a stolen instrument. - * Values are from 0.0 (lowest) to 1.0 (highest). + * Output only. Probability of this transaction being executed with a stolen + * instrument. Values are from 0.0 (lowest) to 1.0 (highest). * - * Generated from protobuf field float risk = 1; + * Generated from protobuf field float risk = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param float $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/IOSKeySettings.php b/RecaptchaEnterprise/src/V1/IOSKeySettings.php index a35e132ed640..b682092cc240 100644 --- a/RecaptchaEnterprise/src/V1/IOSKeySettings.php +++ b/RecaptchaEnterprise/src/V1/IOSKeySettings.php @@ -16,26 +16,26 @@ class IOSKeySettings extends \Google\Protobuf\Internal\Message { /** - * If set to true, allowed_bundle_ids are not enforced. + * Optional. If set to true, allowed_bundle_ids are not enforced. * - * Generated from protobuf field bool allow_all_bundle_ids = 2; + * Generated from protobuf field bool allow_all_bundle_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $allow_all_bundle_ids = false; /** - * iOS bundle ids of apps allowed to use the key. + * Optional. iOS bundle ids of apps allowed to use the key. * Example: 'com.companyname.productname.appname' * - * Generated from protobuf field repeated string allowed_bundle_ids = 1; + * Generated from protobuf field repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $allowed_bundle_ids; /** - * Apple Developer account details for the app that is protected by the - * reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like - * Apple App Attest and Apple DeviceCheck to protect your app from abuse. + * Optional. Apple Developer account details for the app that is protected by + * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks + * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. * Providing these fields allows reCAPTCHA Enterprise to get a better * assessment of the integrity of your app. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $apple_developer_id = null; @@ -46,14 +46,14 @@ class IOSKeySettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $allow_all_bundle_ids - * If set to true, allowed_bundle_ids are not enforced. + * Optional. If set to true, allowed_bundle_ids are not enforced. * @type array|\Google\Protobuf\Internal\RepeatedField $allowed_bundle_ids - * iOS bundle ids of apps allowed to use the key. + * Optional. iOS bundle ids of apps allowed to use the key. * Example: 'com.companyname.productname.appname' * @type \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId $apple_developer_id - * Apple Developer account details for the app that is protected by the - * reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like - * Apple App Attest and Apple DeviceCheck to protect your app from abuse. + * Optional. Apple Developer account details for the app that is protected by + * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks + * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. * Providing these fields allows reCAPTCHA Enterprise to get a better * assessment of the integrity of your app. * } @@ -64,9 +64,9 @@ public function __construct($data = NULL) { } /** - * If set to true, allowed_bundle_ids are not enforced. + * Optional. If set to true, allowed_bundle_ids are not enforced. * - * Generated from protobuf field bool allow_all_bundle_ids = 2; + * Generated from protobuf field bool allow_all_bundle_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getAllowAllBundleIds() @@ -75,9 +75,9 @@ public function getAllowAllBundleIds() } /** - * If set to true, allowed_bundle_ids are not enforced. + * Optional. If set to true, allowed_bundle_ids are not enforced. * - * Generated from protobuf field bool allow_all_bundle_ids = 2; + * Generated from protobuf field bool allow_all_bundle_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -90,10 +90,10 @@ public function setAllowAllBundleIds($var) } /** - * iOS bundle ids of apps allowed to use the key. + * Optional. iOS bundle ids of apps allowed to use the key. * Example: 'com.companyname.productname.appname' * - * Generated from protobuf field repeated string allowed_bundle_ids = 1; + * Generated from protobuf field repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAllowedBundleIds() @@ -102,10 +102,10 @@ public function getAllowedBundleIds() } /** - * iOS bundle ids of apps allowed to use the key. + * Optional. iOS bundle ids of apps allowed to use the key. * Example: 'com.companyname.productname.appname' * - * Generated from protobuf field repeated string allowed_bundle_ids = 1; + * Generated from protobuf field repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -118,13 +118,13 @@ public function setAllowedBundleIds($var) } /** - * Apple Developer account details for the app that is protected by the - * reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like - * Apple App Attest and Apple DeviceCheck to protect your app from abuse. + * Optional. Apple Developer account details for the app that is protected by + * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks + * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. * Providing these fields allows reCAPTCHA Enterprise to get a better * assessment of the integrity of your app. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId|null */ public function getAppleDeveloperId() @@ -143,13 +143,13 @@ public function clearAppleDeveloperId() } /** - * Apple Developer account details for the app that is protected by the - * reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like - * Apple App Attest and Apple DeviceCheck to protect your app from abuse. + * Optional. Apple Developer account details for the app that is protected by + * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks + * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. * Providing these fields allows reCAPTCHA Enterprise to get a better * assessment of the integrity of your app. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/Key.php b/RecaptchaEnterprise/src/V1/Key.php index 55fbd91acd6f..f3a81b391f90 100644 --- a/RecaptchaEnterprise/src/V1/Key.php +++ b/RecaptchaEnterprise/src/V1/Key.php @@ -24,16 +24,16 @@ class Key extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * Human-readable display name of this key. Modifiable by user. + * Required. Human-readable display name of this key. Modifiable by user. * - * Generated from protobuf field string display_name = 2; + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; */ private $display_name = ''; /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/recaptcha-enterprise/docs/labels). * - * Generated from protobuf field map labels = 6; + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $labels; /** @@ -43,15 +43,15 @@ class Key extends \Google\Protobuf\Internal\Message */ private $create_time = null; /** - * Options for user acceptance testing. + * Optional. Options for user acceptance testing. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL]; */ private $testing_options = null; /** - * Settings for WAF + * Optional. Settings for WAF * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL]; */ private $waf_settings = null; protected $platform_settings; @@ -66,7 +66,7 @@ class Key extends \Google\Protobuf\Internal\Message * The resource name for the Key in the format * `projects/{project}/keys/{key}`. * @type string $display_name - * Human-readable display name of this key. Modifiable by user. + * Required. Human-readable display name of this key. Modifiable by user. * @type \Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings $web_settings * Settings for keys that can be used by websites. * @type \Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings $android_settings @@ -74,14 +74,14 @@ class Key extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings $ios_settings * Settings for keys that can be used by iOS apps. * @type array|\Google\Protobuf\Internal\MapField $labels - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/recaptcha-enterprise/docs/labels). * @type \Google\Protobuf\Timestamp $create_time * Output only. The timestamp corresponding to the creation of this key. * @type \Google\Cloud\RecaptchaEnterprise\V1\TestingOptions $testing_options - * Options for user acceptance testing. + * Optional. Options for user acceptance testing. * @type \Google\Cloud\RecaptchaEnterprise\V1\WafSettings $waf_settings - * Settings for WAF + * Optional. Settings for WAF * } */ public function __construct($data = NULL) { @@ -118,9 +118,9 @@ public function setName($var) } /** - * Human-readable display name of this key. Modifiable by user. + * Required. Human-readable display name of this key. Modifiable by user. * - * Generated from protobuf field string display_name = 2; + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getDisplayName() @@ -129,9 +129,9 @@ public function getDisplayName() } /** - * Human-readable display name of this key. Modifiable by user. + * Required. Human-readable display name of this key. Modifiable by user. * - * Generated from protobuf field string display_name = 2; + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ @@ -237,10 +237,10 @@ public function setIosSettings($var) } /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/recaptcha-enterprise/docs/labels). * - * Generated from protobuf field map labels = 6; + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField */ public function getLabels() @@ -249,10 +249,10 @@ public function getLabels() } /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/recaptcha-enterprise/docs/labels). * - * Generated from protobuf field map labels = 6; + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ @@ -301,9 +301,9 @@ public function setCreateTime($var) } /** - * Options for user acceptance testing. + * Optional. Options for user acceptance testing. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\TestingOptions|null */ public function getTestingOptions() @@ -322,9 +322,9 @@ public function clearTestingOptions() } /** - * Options for user acceptance testing. + * Optional. Options for user acceptance testing. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\TestingOptions $var * @return $this */ @@ -337,9 +337,9 @@ public function setTestingOptions($var) } /** - * Settings for WAF + * Optional. Settings for WAF * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\WafSettings|null */ public function getWafSettings() @@ -358,9 +358,9 @@ public function clearWafSettings() } /** - * Settings for WAF + * Optional. Settings for WAF * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\WafSettings $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/PrivatePasswordLeakVerification.php b/RecaptchaEnterprise/src/V1/PrivatePasswordLeakVerification.php index 21c1bc6b41ed..a2b3a46dc659 100644 --- a/RecaptchaEnterprise/src/V1/PrivatePasswordLeakVerification.php +++ b/RecaptchaEnterprise/src/V1/PrivatePasswordLeakVerification.php @@ -16,11 +16,11 @@ class PrivatePasswordLeakVerification extends \Google\Protobuf\Internal\Message { /** - * Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized + * Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized * username. It is used to look up password leaks associated with that hash * prefix. * - * Generated from protobuf field bytes lookup_hash_prefix = 1 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field bytes lookup_hash_prefix = 1 [(.google.api.field_behavior) = REQUIRED]; */ private $lookup_hash_prefix = ''; /** @@ -55,7 +55,7 @@ class PrivatePasswordLeakVerification extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $lookup_hash_prefix - * Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized + * Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized * username. It is used to look up password leaks associated with that hash * prefix. * @type string $encrypted_user_credentials_hash @@ -78,11 +78,11 @@ public function __construct($data = NULL) { } /** - * Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized + * Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized * username. It is used to look up password leaks associated with that hash * prefix. * - * Generated from protobuf field bytes lookup_hash_prefix = 1 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field bytes lookup_hash_prefix = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getLookupHashPrefix() @@ -91,11 +91,11 @@ public function getLookupHashPrefix() } /** - * Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized + * Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized * username. It is used to look up password leaks associated with that hash * prefix. * - * Generated from protobuf field bytes lookup_hash_prefix = 1 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field bytes lookup_hash_prefix = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/RiskAnalysis.php b/RecaptchaEnterprise/src/V1/RiskAnalysis.php index cc8f0efff2fd..46356d7be939 100644 --- a/RecaptchaEnterprise/src/V1/RiskAnalysis.php +++ b/RecaptchaEnterprise/src/V1/RiskAnalysis.php @@ -16,24 +16,24 @@ class RiskAnalysis extends \Google\Protobuf\Internal\Message { /** - * Legitimate event score from 0.0 to 1.0. + * Output only. Legitimate event score from 0.0 to 1.0. * (1.0 means very likely legitimate traffic while 0.0 means very likely * non-legitimate traffic). * - * Generated from protobuf field float score = 1; + * Generated from protobuf field float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $score = 0.0; /** - * Reasons contributing to the risk analysis verdict. + * Output only. Reasons contributing to the risk analysis verdict. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $reasons; /** - * Extended verdict reasons to be used for experimentation only. The set of - * possible reasons is subject to change. + * Output only. Extended verdict reasons to be used for experimentation only. + * The set of possible reasons is subject to change. * - * Generated from protobuf field repeated string extended_verdict_reasons = 3; + * Generated from protobuf field repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $extended_verdict_reasons; @@ -44,14 +44,14 @@ class RiskAnalysis extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $score - * Legitimate event score from 0.0 to 1.0. + * Output only. Legitimate event score from 0.0 to 1.0. * (1.0 means very likely legitimate traffic while 0.0 means very likely * non-legitimate traffic). * @type array|\Google\Protobuf\Internal\RepeatedField $reasons - * Reasons contributing to the risk analysis verdict. + * Output only. Reasons contributing to the risk analysis verdict. * @type array|\Google\Protobuf\Internal\RepeatedField $extended_verdict_reasons - * Extended verdict reasons to be used for experimentation only. The set of - * possible reasons is subject to change. + * Output only. Extended verdict reasons to be used for experimentation only. + * The set of possible reasons is subject to change. * } */ public function __construct($data = NULL) { @@ -60,11 +60,11 @@ public function __construct($data = NULL) { } /** - * Legitimate event score from 0.0 to 1.0. + * Output only. Legitimate event score from 0.0 to 1.0. * (1.0 means very likely legitimate traffic while 0.0 means very likely * non-legitimate traffic). * - * Generated from protobuf field float score = 1; + * Generated from protobuf field float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return float */ public function getScore() @@ -73,11 +73,11 @@ public function getScore() } /** - * Legitimate event score from 0.0 to 1.0. + * Output only. Legitimate event score from 0.0 to 1.0. * (1.0 means very likely legitimate traffic while 0.0 means very likely * non-legitimate traffic). * - * Generated from protobuf field float score = 1; + * Generated from protobuf field float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param float $var * @return $this */ @@ -90,9 +90,9 @@ public function setScore($var) } /** - * Reasons contributing to the risk analysis verdict. + * Output only. Reasons contributing to the risk analysis verdict. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getReasons() @@ -101,9 +101,9 @@ public function getReasons() } /** - * Reasons contributing to the risk analysis verdict. + * Output only. Reasons contributing to the risk analysis verdict. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -116,10 +116,10 @@ public function setReasons($var) } /** - * Extended verdict reasons to be used for experimentation only. The set of - * possible reasons is subject to change. + * Output only. Extended verdict reasons to be used for experimentation only. + * The set of possible reasons is subject to change. * - * Generated from protobuf field repeated string extended_verdict_reasons = 3; + * Generated from protobuf field repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getExtendedVerdictReasons() @@ -128,10 +128,10 @@ public function getExtendedVerdictReasons() } /** - * Extended verdict reasons to be used for experimentation only. The set of - * possible reasons is subject to change. + * Output only. Extended verdict reasons to be used for experimentation only. + * The set of possible reasons is subject to change. * - * Generated from protobuf field repeated string extended_verdict_reasons = 3; + * Generated from protobuf field repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/TestingOptions.php b/RecaptchaEnterprise/src/V1/TestingOptions.php index 379a4d74ce4a..aeb1cae39c37 100644 --- a/RecaptchaEnterprise/src/V1/TestingOptions.php +++ b/RecaptchaEnterprise/src/V1/TestingOptions.php @@ -16,18 +16,18 @@ class TestingOptions extends \Google\Protobuf\Internal\Message { /** - * All assessments for this Key will return this score. Must be between 0 - * (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key will return this score. Must be + * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. * - * Generated from protobuf field float testing_score = 1; + * Generated from protobuf field float testing_score = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $testing_score = 0.0; /** - * For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests - * for this site will return nocaptcha if NOCAPTCHA, or an unsolvable - * challenge if CHALLENGE. + * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * unsolvable challenge if CHALLENGE. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $testing_challenge = 0; @@ -38,12 +38,12 @@ class TestingOptions extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $testing_score - * All assessments for this Key will return this score. Must be between 0 - * (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key will return this score. Must be + * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. * @type int $testing_challenge - * For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests - * for this site will return nocaptcha if NOCAPTCHA, or an unsolvable - * challenge if CHALLENGE. + * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * unsolvable challenge if CHALLENGE. * } */ public function __construct($data = NULL) { @@ -52,10 +52,10 @@ public function __construct($data = NULL) { } /** - * All assessments for this Key will return this score. Must be between 0 - * (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key will return this score. Must be + * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. * - * Generated from protobuf field float testing_score = 1; + * Generated from protobuf field float testing_score = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return float */ public function getTestingScore() @@ -64,10 +64,10 @@ public function getTestingScore() } /** - * All assessments for this Key will return this score. Must be between 0 - * (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key will return this score. Must be + * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. * - * Generated from protobuf field float testing_score = 1; + * Generated from protobuf field float testing_score = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var * @return $this */ @@ -80,11 +80,11 @@ public function setTestingScore($var) } /** - * For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests - * for this site will return nocaptcha if NOCAPTCHA, or an unsolvable - * challenge if CHALLENGE. + * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * unsolvable challenge if CHALLENGE. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getTestingChallenge() @@ -93,11 +93,11 @@ public function getTestingChallenge() } /** - * For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests - * for this site will return nocaptcha if NOCAPTCHA, or an unsolvable - * challenge if CHALLENGE. + * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * unsolvable challenge if CHALLENGE. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/TokenProperties.php b/RecaptchaEnterprise/src/V1/TokenProperties.php index b45f354b37c8..66a42f3f3a4d 100644 --- a/RecaptchaEnterprise/src/V1/TokenProperties.php +++ b/RecaptchaEnterprise/src/V1/TokenProperties.php @@ -16,51 +16,52 @@ class TokenProperties extends \Google\Protobuf\Internal\Message { /** - * Whether the provided user response token is valid. When valid = false, the - * reason could be specified in invalid_reason or it could also be due to - * a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey - * used to generate the token was different than the one specified in the - * assessment). + * Output only. Whether the provided user response token is valid. When valid + * = false, the reason could be specified in invalid_reason or it could also + * be due to a user failing to solve a challenge or a sitekey mismatch (i.e + * the sitekey used to generate the token was different than the one specified + * in the assessment). * - * Generated from protobuf field bool valid = 1; + * Generated from protobuf field bool valid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $valid = false; /** - * Reason associated with the response when valid = false. + * Output only. Reason associated with the response when valid = false. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $invalid_reason = 0; /** - * The timestamp corresponding to the generation of the token. + * Output only. The timestamp corresponding to the generation of the token. * - * Generated from protobuf field .google.protobuf.Timestamp create_time = 3; + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $create_time = null; /** - * The hostname of the page on which the token was generated (Web keys only). + * Output only. The hostname of the page on which the token was generated (Web + * keys only). * - * Generated from protobuf field string hostname = 4; + * Generated from protobuf field string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $hostname = ''; /** - * The name of the Android package with which the token was generated (Android - * keys only). + * Output only. The name of the Android package with which the token was + * generated (Android keys only). * - * Generated from protobuf field string android_package_name = 8; + * Generated from protobuf field string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $android_package_name = ''; /** - * The ID of the iOS bundle with which the token was generated (iOS keys - * only). + * Output only. The ID of the iOS bundle with which the token was generated + * (iOS keys only). * - * Generated from protobuf field string ios_bundle_id = 9; + * Generated from protobuf field string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $ios_bundle_id = ''; /** - * Action name provided at token generation. + * Output only. Action name provided at token generation. * - * Generated from protobuf field string action = 5; + * Generated from protobuf field string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $action = ''; @@ -71,25 +72,26 @@ class TokenProperties extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $valid - * Whether the provided user response token is valid. When valid = false, the - * reason could be specified in invalid_reason or it could also be due to - * a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey - * used to generate the token was different than the one specified in the - * assessment). + * Output only. Whether the provided user response token is valid. When valid + * = false, the reason could be specified in invalid_reason or it could also + * be due to a user failing to solve a challenge or a sitekey mismatch (i.e + * the sitekey used to generate the token was different than the one specified + * in the assessment). * @type int $invalid_reason - * Reason associated with the response when valid = false. + * Output only. Reason associated with the response when valid = false. * @type \Google\Protobuf\Timestamp $create_time - * The timestamp corresponding to the generation of the token. + * Output only. The timestamp corresponding to the generation of the token. * @type string $hostname - * The hostname of the page on which the token was generated (Web keys only). - * @type string $android_package_name - * The name of the Android package with which the token was generated (Android + * Output only. The hostname of the page on which the token was generated (Web * keys only). + * @type string $android_package_name + * Output only. The name of the Android package with which the token was + * generated (Android keys only). * @type string $ios_bundle_id - * The ID of the iOS bundle with which the token was generated (iOS keys - * only). + * Output only. The ID of the iOS bundle with which the token was generated + * (iOS keys only). * @type string $action - * Action name provided at token generation. + * Output only. Action name provided at token generation. * } */ public function __construct($data = NULL) { @@ -98,13 +100,13 @@ public function __construct($data = NULL) { } /** - * Whether the provided user response token is valid. When valid = false, the - * reason could be specified in invalid_reason or it could also be due to - * a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey - * used to generate the token was different than the one specified in the - * assessment). + * Output only. Whether the provided user response token is valid. When valid + * = false, the reason could be specified in invalid_reason or it could also + * be due to a user failing to solve a challenge or a sitekey mismatch (i.e + * the sitekey used to generate the token was different than the one specified + * in the assessment). * - * Generated from protobuf field bool valid = 1; + * Generated from protobuf field bool valid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return bool */ public function getValid() @@ -113,13 +115,13 @@ public function getValid() } /** - * Whether the provided user response token is valid. When valid = false, the - * reason could be specified in invalid_reason or it could also be due to - * a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey - * used to generate the token was different than the one specified in the - * assessment). + * Output only. Whether the provided user response token is valid. When valid + * = false, the reason could be specified in invalid_reason or it could also + * be due to a user failing to solve a challenge or a sitekey mismatch (i.e + * the sitekey used to generate the token was different than the one specified + * in the assessment). * - * Generated from protobuf field bool valid = 1; + * Generated from protobuf field bool valid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param bool $var * @return $this */ @@ -132,9 +134,9 @@ public function setValid($var) } /** - * Reason associated with the response when valid = false. + * Output only. Reason associated with the response when valid = false. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int */ public function getInvalidReason() @@ -143,9 +145,9 @@ public function getInvalidReason() } /** - * Reason associated with the response when valid = false. + * Output only. Reason associated with the response when valid = false. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var * @return $this */ @@ -158,9 +160,9 @@ public function setInvalidReason($var) } /** - * The timestamp corresponding to the generation of the token. + * Output only. The timestamp corresponding to the generation of the token. * - * Generated from protobuf field .google.protobuf.Timestamp create_time = 3; + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Timestamp|null */ public function getCreateTime() @@ -179,9 +181,9 @@ public function clearCreateTime() } /** - * The timestamp corresponding to the generation of the token. + * Output only. The timestamp corresponding to the generation of the token. * - * Generated from protobuf field .google.protobuf.Timestamp create_time = 3; + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Protobuf\Timestamp $var * @return $this */ @@ -194,9 +196,10 @@ public function setCreateTime($var) } /** - * The hostname of the page on which the token was generated (Web keys only). + * Output only. The hostname of the page on which the token was generated (Web + * keys only). * - * Generated from protobuf field string hostname = 4; + * Generated from protobuf field string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string */ public function getHostname() @@ -205,9 +208,10 @@ public function getHostname() } /** - * The hostname of the page on which the token was generated (Web keys only). + * Output only. The hostname of the page on which the token was generated (Web + * keys only). * - * Generated from protobuf field string hostname = 4; + * Generated from protobuf field string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var * @return $this */ @@ -220,10 +224,10 @@ public function setHostname($var) } /** - * The name of the Android package with which the token was generated (Android - * keys only). + * Output only. The name of the Android package with which the token was + * generated (Android keys only). * - * Generated from protobuf field string android_package_name = 8; + * Generated from protobuf field string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string */ public function getAndroidPackageName() @@ -232,10 +236,10 @@ public function getAndroidPackageName() } /** - * The name of the Android package with which the token was generated (Android - * keys only). + * Output only. The name of the Android package with which the token was + * generated (Android keys only). * - * Generated from protobuf field string android_package_name = 8; + * Generated from protobuf field string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var * @return $this */ @@ -248,10 +252,10 @@ public function setAndroidPackageName($var) } /** - * The ID of the iOS bundle with which the token was generated (iOS keys - * only). + * Output only. The ID of the iOS bundle with which the token was generated + * (iOS keys only). * - * Generated from protobuf field string ios_bundle_id = 9; + * Generated from protobuf field string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string */ public function getIosBundleId() @@ -260,10 +264,10 @@ public function getIosBundleId() } /** - * The ID of the iOS bundle with which the token was generated (iOS keys - * only). + * Output only. The ID of the iOS bundle with which the token was generated + * (iOS keys only). * - * Generated from protobuf field string ios_bundle_id = 9; + * Generated from protobuf field string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var * @return $this */ @@ -276,9 +280,9 @@ public function setIosBundleId($var) } /** - * Action name provided at token generation. + * Output only. Action name provided at token generation. * - * Generated from protobuf field string action = 5; + * Generated from protobuf field string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string */ public function getAction() @@ -287,9 +291,9 @@ public function getAction() } /** - * Action name provided at token generation. + * Output only. Action name provided at token generation. * - * Generated from protobuf field string action = 5; + * Generated from protobuf field string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/TransactionData.php b/RecaptchaEnterprise/src/V1/TransactionData.php index 6db049eb630e..1c8e3e81d939 100644 --- a/RecaptchaEnterprise/src/V1/TransactionData.php +++ b/RecaptchaEnterprise/src/V1/TransactionData.php @@ -10,7 +10,6 @@ /** * Transaction data associated with a payment protected by reCAPTCHA Enterprise. - * All fields are optional. * * Generated from protobuf message google.cloud.recaptchaenterprise.v1.TransactionData */ @@ -26,7 +25,7 @@ class TransactionData extends \Google\Protobuf\Internal\Message */ private $transaction_id = null; /** - * The payment method for the transaction. The allowed values are: + * Optional. The payment method for the transaction. The allowed values are: * * credit-card * * debit-card * * gift-card @@ -35,74 +34,77 @@ class TransactionData extends \Google\Protobuf\Internal\Message * * custom-{name} (If an alternative method is used, for example, * custom-crypto) * - * Generated from protobuf field string payment_method = 1; + * Generated from protobuf field string payment_method = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $payment_method = ''; /** - * The Bank Identification Number - generally the first 6 or 8 digits of the - * card. + * Optional. The Bank Identification Number - generally the first 6 or 8 + * digits of the card. * - * Generated from protobuf field string card_bin = 2; + * Generated from protobuf field string card_bin = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $card_bin = ''; /** - * The last four digits of the card. + * Optional. The last four digits of the card. * - * Generated from protobuf field string card_last_four = 3; + * Generated from protobuf field string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $card_last_four = ''; /** - * The currency code in ISO-4217 format. + * Optional. The currency code in ISO-4217 format. * - * Generated from protobuf field string currency_code = 4; + * Generated from protobuf field string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $currency_code = ''; /** - * The decimal value of the transaction in the specified currency. + * Optional. The decimal value of the transaction in the specified currency. * - * Generated from protobuf field double value = 5; + * Generated from protobuf field double value = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $value = 0.0; /** - * The value of shipping in the specified currency. 0 for free or no shipping. + * Optional. The value of shipping in the specified currency. 0 for free or no + * shipping. * - * Generated from protobuf field double shipping_value = 12; + * Generated from protobuf field double shipping_value = 12 [(.google.api.field_behavior) = OPTIONAL]; */ private $shipping_value = 0.0; /** - * Destination address if this transaction involves shipping a physical item. + * Optional. Destination address if this transaction involves shipping a + * physical item. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $shipping_address = null; /** - * Address associated with the payment method when applicable. + * Optional. Address associated with the payment method when applicable. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL]; */ private $billing_address = null; /** - * Information about the user paying/initiating the transaction. + * Optional. Information about the user paying/initiating the transaction. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL]; */ private $user = null; /** - * Information about the user or users fulfilling the transaction. + * Optional. Information about the user or users fulfilling the transaction. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL]; */ private $merchants; /** - * Items purchased in this transaction. + * Optional. Items purchased in this transaction. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL]; */ private $items; /** - * Information about the payment gateway's response to the transaction. + * Optional. Information about the payment gateway's response to the + * transaction. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL]; */ private $gateway_info = null; @@ -118,7 +120,7 @@ class TransactionData extends \Google\Protobuf\Internal\Message * or chargeback event. Two attempts at the same transaction should use the * same transaction id. * @type string $payment_method - * The payment method for the transaction. The allowed values are: + * Optional. The payment method for the transaction. The allowed values are: * * credit-card * * debit-card * * gift-card @@ -127,28 +129,31 @@ class TransactionData extends \Google\Protobuf\Internal\Message * * custom-{name} (If an alternative method is used, for example, * custom-crypto) * @type string $card_bin - * The Bank Identification Number - generally the first 6 or 8 digits of the - * card. + * Optional. The Bank Identification Number - generally the first 6 or 8 + * digits of the card. * @type string $card_last_four - * The last four digits of the card. + * Optional. The last four digits of the card. * @type string $currency_code - * The currency code in ISO-4217 format. + * Optional. The currency code in ISO-4217 format. * @type float $value - * The decimal value of the transaction in the specified currency. + * Optional. The decimal value of the transaction in the specified currency. * @type float $shipping_value - * The value of shipping in the specified currency. 0 for free or no shipping. + * Optional. The value of shipping in the specified currency. 0 for free or no + * shipping. * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $shipping_address - * Destination address if this transaction involves shipping a physical item. + * Optional. Destination address if this transaction involves shipping a + * physical item. * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $billing_address - * Address associated with the payment method when applicable. + * Optional. Address associated with the payment method when applicable. * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User $user - * Information about the user paying/initiating the transaction. + * Optional. Information about the user paying/initiating the transaction. * @type array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User>|\Google\Protobuf\Internal\RepeatedField $merchants - * Information about the user or users fulfilling the transaction. + * Optional. Information about the user or users fulfilling the transaction. * @type array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Item>|\Google\Protobuf\Internal\RepeatedField $items - * Items purchased in this transaction. + * Optional. Items purchased in this transaction. * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\GatewayInfo $gateway_info - * Information about the payment gateway's response to the transaction. + * Optional. Information about the payment gateway's response to the + * transaction. * } */ public function __construct($data = NULL) { @@ -199,7 +204,7 @@ public function setTransactionId($var) } /** - * The payment method for the transaction. The allowed values are: + * Optional. The payment method for the transaction. The allowed values are: * * credit-card * * debit-card * * gift-card @@ -208,7 +213,7 @@ public function setTransactionId($var) * * custom-{name} (If an alternative method is used, for example, * custom-crypto) * - * Generated from protobuf field string payment_method = 1; + * Generated from protobuf field string payment_method = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPaymentMethod() @@ -217,7 +222,7 @@ public function getPaymentMethod() } /** - * The payment method for the transaction. The allowed values are: + * Optional. The payment method for the transaction. The allowed values are: * * credit-card * * debit-card * * gift-card @@ -226,7 +231,7 @@ public function getPaymentMethod() * * custom-{name} (If an alternative method is used, for example, * custom-crypto) * - * Generated from protobuf field string payment_method = 1; + * Generated from protobuf field string payment_method = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -239,10 +244,10 @@ public function setPaymentMethod($var) } /** - * The Bank Identification Number - generally the first 6 or 8 digits of the - * card. + * Optional. The Bank Identification Number - generally the first 6 or 8 + * digits of the card. * - * Generated from protobuf field string card_bin = 2; + * Generated from protobuf field string card_bin = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getCardBin() @@ -251,10 +256,10 @@ public function getCardBin() } /** - * The Bank Identification Number - generally the first 6 or 8 digits of the - * card. + * Optional. The Bank Identification Number - generally the first 6 or 8 + * digits of the card. * - * Generated from protobuf field string card_bin = 2; + * Generated from protobuf field string card_bin = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -267,9 +272,9 @@ public function setCardBin($var) } /** - * The last four digits of the card. + * Optional. The last four digits of the card. * - * Generated from protobuf field string card_last_four = 3; + * Generated from protobuf field string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getCardLastFour() @@ -278,9 +283,9 @@ public function getCardLastFour() } /** - * The last four digits of the card. + * Optional. The last four digits of the card. * - * Generated from protobuf field string card_last_four = 3; + * Generated from protobuf field string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -293,9 +298,9 @@ public function setCardLastFour($var) } /** - * The currency code in ISO-4217 format. + * Optional. The currency code in ISO-4217 format. * - * Generated from protobuf field string currency_code = 4; + * Generated from protobuf field string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getCurrencyCode() @@ -304,9 +309,9 @@ public function getCurrencyCode() } /** - * The currency code in ISO-4217 format. + * Optional. The currency code in ISO-4217 format. * - * Generated from protobuf field string currency_code = 4; + * Generated from protobuf field string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -319,9 +324,9 @@ public function setCurrencyCode($var) } /** - * The decimal value of the transaction in the specified currency. + * Optional. The decimal value of the transaction in the specified currency. * - * Generated from protobuf field double value = 5; + * Generated from protobuf field double value = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return float */ public function getValue() @@ -330,9 +335,9 @@ public function getValue() } /** - * The decimal value of the transaction in the specified currency. + * Optional. The decimal value of the transaction in the specified currency. * - * Generated from protobuf field double value = 5; + * Generated from protobuf field double value = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var * @return $this */ @@ -345,9 +350,10 @@ public function setValue($var) } /** - * The value of shipping in the specified currency. 0 for free or no shipping. + * Optional. The value of shipping in the specified currency. 0 for free or no + * shipping. * - * Generated from protobuf field double shipping_value = 12; + * Generated from protobuf field double shipping_value = 12 [(.google.api.field_behavior) = OPTIONAL]; * @return float */ public function getShippingValue() @@ -356,9 +362,10 @@ public function getShippingValue() } /** - * The value of shipping in the specified currency. 0 for free or no shipping. + * Optional. The value of shipping in the specified currency. 0 for free or no + * shipping. * - * Generated from protobuf field double shipping_value = 12; + * Generated from protobuf field double shipping_value = 12 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var * @return $this */ @@ -371,9 +378,10 @@ public function setShippingValue($var) } /** - * Destination address if this transaction involves shipping a physical item. + * Optional. Destination address if this transaction involves shipping a + * physical item. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address|null */ public function getShippingAddress() @@ -392,9 +400,10 @@ public function clearShippingAddress() } /** - * Destination address if this transaction involves shipping a physical item. + * Optional. Destination address if this transaction involves shipping a + * physical item. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $var * @return $this */ @@ -407,9 +416,9 @@ public function setShippingAddress($var) } /** - * Address associated with the payment method when applicable. + * Optional. Address associated with the payment method when applicable. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address|null */ public function getBillingAddress() @@ -428,9 +437,9 @@ public function clearBillingAddress() } /** - * Address associated with the payment method when applicable. + * Optional. Address associated with the payment method when applicable. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $var * @return $this */ @@ -443,9 +452,9 @@ public function setBillingAddress($var) } /** - * Information about the user paying/initiating the transaction. + * Optional. Information about the user paying/initiating the transaction. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User|null */ public function getUser() @@ -464,9 +473,9 @@ public function clearUser() } /** - * Information about the user paying/initiating the transaction. + * Optional. Information about the user paying/initiating the transaction. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User $var * @return $this */ @@ -479,9 +488,9 @@ public function setUser($var) } /** - * Information about the user or users fulfilling the transaction. + * Optional. Information about the user or users fulfilling the transaction. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getMerchants() @@ -490,9 +499,9 @@ public function getMerchants() } /** - * Information about the user or users fulfilling the transaction. + * Optional. Information about the user or users fulfilling the transaction. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -505,9 +514,9 @@ public function setMerchants($var) } /** - * Items purchased in this transaction. + * Optional. Items purchased in this transaction. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getItems() @@ -516,9 +525,9 @@ public function getItems() } /** - * Items purchased in this transaction. + * Optional. Items purchased in this transaction. * - * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14; + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Item>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -531,9 +540,10 @@ public function setItems($var) } /** - * Information about the payment gateway's response to the transaction. + * Optional. Information about the payment gateway's response to the + * transaction. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\GatewayInfo|null */ public function getGatewayInfo() @@ -552,9 +562,10 @@ public function clearGatewayInfo() } /** - * Information about the payment gateway's response to the transaction. + * Optional. Information about the payment gateway's response to the + * transaction. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\GatewayInfo $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/TransactionData/Address.php b/RecaptchaEnterprise/src/V1/TransactionData/Address.php index c7608ebdeea1..792b05e42f4a 100644 --- a/RecaptchaEnterprise/src/V1/TransactionData/Address.php +++ b/RecaptchaEnterprise/src/V1/TransactionData/Address.php @@ -16,41 +16,43 @@ class Address extends \Google\Protobuf\Internal\Message { /** - * The recipient name, potentially including information such as "care of". + * Optional. The recipient name, potentially including information such as + * "care of". * - * Generated from protobuf field string recipient = 1; + * Generated from protobuf field string recipient = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $recipient = ''; /** - * The first lines of the address. The first line generally contains the - * street name and number, and further lines may include information such as - * an apartment number. + * Optional. The first lines of the address. The first line generally + * contains the street name and number, and further lines may include + * information such as an apartment number. * - * Generated from protobuf field repeated string address = 2; + * Generated from protobuf field repeated string address = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $address; /** - * The town/city of the address. + * Optional. The town/city of the address. * - * Generated from protobuf field string locality = 3; + * Generated from protobuf field string locality = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $locality = ''; /** - * The state, province, or otherwise administrative area of the address. + * Optional. The state, province, or otherwise administrative area of the + * address. * - * Generated from protobuf field string administrative_area = 4; + * Generated from protobuf field string administrative_area = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $administrative_area = ''; /** - * The CLDR country/region of the address. + * Optional. The CLDR country/region of the address. * - * Generated from protobuf field string region_code = 5; + * Generated from protobuf field string region_code = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $region_code = ''; /** - * The postal or ZIP code of the address. + * Optional. The postal or ZIP code of the address. * - * Generated from protobuf field string postal_code = 6; + * Generated from protobuf field string postal_code = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $postal_code = ''; @@ -61,19 +63,21 @@ class Address extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $recipient - * The recipient name, potentially including information such as "care of". + * Optional. The recipient name, potentially including information such as + * "care of". * @type array|\Google\Protobuf\Internal\RepeatedField $address - * The first lines of the address. The first line generally contains the - * street name and number, and further lines may include information such as - * an apartment number. + * Optional. The first lines of the address. The first line generally + * contains the street name and number, and further lines may include + * information such as an apartment number. * @type string $locality - * The town/city of the address. + * Optional. The town/city of the address. * @type string $administrative_area - * The state, province, or otherwise administrative area of the address. + * Optional. The state, province, or otherwise administrative area of the + * address. * @type string $region_code - * The CLDR country/region of the address. + * Optional. The CLDR country/region of the address. * @type string $postal_code - * The postal or ZIP code of the address. + * Optional. The postal or ZIP code of the address. * } */ public function __construct($data = NULL) { @@ -82,9 +86,10 @@ public function __construct($data = NULL) { } /** - * The recipient name, potentially including information such as "care of". + * Optional. The recipient name, potentially including information such as + * "care of". * - * Generated from protobuf field string recipient = 1; + * Generated from protobuf field string recipient = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getRecipient() @@ -93,9 +98,10 @@ public function getRecipient() } /** - * The recipient name, potentially including information such as "care of". + * Optional. The recipient name, potentially including information such as + * "care of". * - * Generated from protobuf field string recipient = 1; + * Generated from protobuf field string recipient = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -108,11 +114,11 @@ public function setRecipient($var) } /** - * The first lines of the address. The first line generally contains the - * street name and number, and further lines may include information such as - * an apartment number. + * Optional. The first lines of the address. The first line generally + * contains the street name and number, and further lines may include + * information such as an apartment number. * - * Generated from protobuf field repeated string address = 2; + * Generated from protobuf field repeated string address = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAddress() @@ -121,11 +127,11 @@ public function getAddress() } /** - * The first lines of the address. The first line generally contains the - * street name and number, and further lines may include information such as - * an apartment number. + * Optional. The first lines of the address. The first line generally + * contains the street name and number, and further lines may include + * information such as an apartment number. * - * Generated from protobuf field repeated string address = 2; + * Generated from protobuf field repeated string address = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -138,9 +144,9 @@ public function setAddress($var) } /** - * The town/city of the address. + * Optional. The town/city of the address. * - * Generated from protobuf field string locality = 3; + * Generated from protobuf field string locality = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getLocality() @@ -149,9 +155,9 @@ public function getLocality() } /** - * The town/city of the address. + * Optional. The town/city of the address. * - * Generated from protobuf field string locality = 3; + * Generated from protobuf field string locality = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -164,9 +170,10 @@ public function setLocality($var) } /** - * The state, province, or otherwise administrative area of the address. + * Optional. The state, province, or otherwise administrative area of the + * address. * - * Generated from protobuf field string administrative_area = 4; + * Generated from protobuf field string administrative_area = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getAdministrativeArea() @@ -175,9 +182,10 @@ public function getAdministrativeArea() } /** - * The state, province, or otherwise administrative area of the address. + * Optional. The state, province, or otherwise administrative area of the + * address. * - * Generated from protobuf field string administrative_area = 4; + * Generated from protobuf field string administrative_area = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -190,9 +198,9 @@ public function setAdministrativeArea($var) } /** - * The CLDR country/region of the address. + * Optional. The CLDR country/region of the address. * - * Generated from protobuf field string region_code = 5; + * Generated from protobuf field string region_code = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getRegionCode() @@ -201,9 +209,9 @@ public function getRegionCode() } /** - * The CLDR country/region of the address. + * Optional. The CLDR country/region of the address. * - * Generated from protobuf field string region_code = 5; + * Generated from protobuf field string region_code = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -216,9 +224,9 @@ public function setRegionCode($var) } /** - * The postal or ZIP code of the address. + * Optional. The postal or ZIP code of the address. * - * Generated from protobuf field string postal_code = 6; + * Generated from protobuf field string postal_code = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPostalCode() @@ -227,9 +235,9 @@ public function getPostalCode() } /** - * The postal or ZIP code of the address. + * Optional. The postal or ZIP code of the address. * - * Generated from protobuf field string postal_code = 6; + * Generated from protobuf field string postal_code = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php b/RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php index ae0020819fd6..b84d8315cc4d 100644 --- a/RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php +++ b/RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php @@ -16,29 +16,30 @@ class GatewayInfo extends \Google\Protobuf\Internal\Message { /** - * Name of the gateway service (for example, stripe, square, paypal). + * Optional. Name of the gateway service (for example, stripe, square, + * paypal). * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $name = ''; /** - * Gateway response code describing the state of the transaction. + * Optional. Gateway response code describing the state of the transaction. * - * Generated from protobuf field string gateway_response_code = 2; + * Generated from protobuf field string gateway_response_code = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $gateway_response_code = ''; /** - * AVS response code from the gateway + * Optional. AVS response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * - * Generated from protobuf field string avs_response_code = 3; + * Generated from protobuf field string avs_response_code = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $avs_response_code = ''; /** - * CVV response code from the gateway + * Optional. CVV response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * - * Generated from protobuf field string cvv_response_code = 4; + * Generated from protobuf field string cvv_response_code = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $cvv_response_code = ''; @@ -49,14 +50,15 @@ class GatewayInfo extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Name of the gateway service (for example, stripe, square, paypal). + * Optional. Name of the gateway service (for example, stripe, square, + * paypal). * @type string $gateway_response_code - * Gateway response code describing the state of the transaction. + * Optional. Gateway response code describing the state of the transaction. * @type string $avs_response_code - * AVS response code from the gateway + * Optional. AVS response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * @type string $cvv_response_code - * CVV response code from the gateway + * Optional. CVV response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * } */ @@ -66,9 +68,10 @@ public function __construct($data = NULL) { } /** - * Name of the gateway service (for example, stripe, square, paypal). + * Optional. Name of the gateway service (for example, stripe, square, + * paypal). * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getName() @@ -77,9 +80,10 @@ public function getName() } /** - * Name of the gateway service (for example, stripe, square, paypal). + * Optional. Name of the gateway service (for example, stripe, square, + * paypal). * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -92,9 +96,9 @@ public function setName($var) } /** - * Gateway response code describing the state of the transaction. + * Optional. Gateway response code describing the state of the transaction. * - * Generated from protobuf field string gateway_response_code = 2; + * Generated from protobuf field string gateway_response_code = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getGatewayResponseCode() @@ -103,9 +107,9 @@ public function getGatewayResponseCode() } /** - * Gateway response code describing the state of the transaction. + * Optional. Gateway response code describing the state of the transaction. * - * Generated from protobuf field string gateway_response_code = 2; + * Generated from protobuf field string gateway_response_code = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -118,10 +122,10 @@ public function setGatewayResponseCode($var) } /** - * AVS response code from the gateway + * Optional. AVS response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * - * Generated from protobuf field string avs_response_code = 3; + * Generated from protobuf field string avs_response_code = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getAvsResponseCode() @@ -130,10 +134,10 @@ public function getAvsResponseCode() } /** - * AVS response code from the gateway + * Optional. AVS response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * - * Generated from protobuf field string avs_response_code = 3; + * Generated from protobuf field string avs_response_code = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -146,10 +150,10 @@ public function setAvsResponseCode($var) } /** - * CVV response code from the gateway + * Optional. CVV response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * - * Generated from protobuf field string cvv_response_code = 4; + * Generated from protobuf field string cvv_response_code = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getCvvResponseCode() @@ -158,10 +162,10 @@ public function getCvvResponseCode() } /** - * CVV response code from the gateway + * Optional. CVV response code from the gateway * (available only when reCAPTCHA Enterprise is called after authorization). * - * Generated from protobuf field string cvv_response_code = 4; + * Generated from protobuf field string cvv_response_code = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/TransactionData/Item.php b/RecaptchaEnterprise/src/V1/TransactionData/Item.php index f9ba08c87be1..c5d03db2afdc 100644 --- a/RecaptchaEnterprise/src/V1/TransactionData/Item.php +++ b/RecaptchaEnterprise/src/V1/TransactionData/Item.php @@ -16,29 +16,29 @@ class Item extends \Google\Protobuf\Internal\Message { /** - * The full name of the item. + * Optional. The full name of the item. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $name = ''; /** - * The value per item that the user is paying, in the transaction currency, - * after discounts. + * Optional. The value per item that the user is paying, in the transaction + * currency, after discounts. * - * Generated from protobuf field double value = 2; + * Generated from protobuf field double value = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $value = 0.0; /** - * The quantity of this item that is being purchased. + * Optional. The quantity of this item that is being purchased. * - * Generated from protobuf field int64 quantity = 3; + * Generated from protobuf field int64 quantity = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $quantity = 0; /** - * When a merchant is specified, its corresponding account_id. Necessary to - * populate marketplace-style transactions. + * Optional. When a merchant is specified, its corresponding account_id. + * Necessary to populate marketplace-style transactions. * - * Generated from protobuf field string merchant_account_id = 4; + * Generated from protobuf field string merchant_account_id = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $merchant_account_id = ''; @@ -49,15 +49,15 @@ class Item extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * The full name of the item. + * Optional. The full name of the item. * @type float $value - * The value per item that the user is paying, in the transaction currency, - * after discounts. + * Optional. The value per item that the user is paying, in the transaction + * currency, after discounts. * @type int|string $quantity - * The quantity of this item that is being purchased. + * Optional. The quantity of this item that is being purchased. * @type string $merchant_account_id - * When a merchant is specified, its corresponding account_id. Necessary to - * populate marketplace-style transactions. + * Optional. When a merchant is specified, its corresponding account_id. + * Necessary to populate marketplace-style transactions. * } */ public function __construct($data = NULL) { @@ -66,9 +66,9 @@ public function __construct($data = NULL) { } /** - * The full name of the item. + * Optional. The full name of the item. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getName() @@ -77,9 +77,9 @@ public function getName() } /** - * The full name of the item. + * Optional. The full name of the item. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -92,10 +92,10 @@ public function setName($var) } /** - * The value per item that the user is paying, in the transaction currency, - * after discounts. + * Optional. The value per item that the user is paying, in the transaction + * currency, after discounts. * - * Generated from protobuf field double value = 2; + * Generated from protobuf field double value = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return float */ public function getValue() @@ -104,10 +104,10 @@ public function getValue() } /** - * The value per item that the user is paying, in the transaction currency, - * after discounts. + * Optional. The value per item that the user is paying, in the transaction + * currency, after discounts. * - * Generated from protobuf field double value = 2; + * Generated from protobuf field double value = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var * @return $this */ @@ -120,9 +120,9 @@ public function setValue($var) } /** - * The quantity of this item that is being purchased. + * Optional. The quantity of this item that is being purchased. * - * Generated from protobuf field int64 quantity = 3; + * Generated from protobuf field int64 quantity = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return int|string */ public function getQuantity() @@ -131,9 +131,9 @@ public function getQuantity() } /** - * The quantity of this item that is being purchased. + * Optional. The quantity of this item that is being purchased. * - * Generated from protobuf field int64 quantity = 3; + * Generated from protobuf field int64 quantity = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param int|string $var * @return $this */ @@ -146,10 +146,10 @@ public function setQuantity($var) } /** - * When a merchant is specified, its corresponding account_id. Necessary to - * populate marketplace-style transactions. + * Optional. When a merchant is specified, its corresponding account_id. + * Necessary to populate marketplace-style transactions. * - * Generated from protobuf field string merchant_account_id = 4; + * Generated from protobuf field string merchant_account_id = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getMerchantAccountId() @@ -158,10 +158,10 @@ public function getMerchantAccountId() } /** - * When a merchant is specified, its corresponding account_id. Necessary to - * populate marketplace-style transactions. + * Optional. When a merchant is specified, its corresponding account_id. + * Necessary to populate marketplace-style transactions. * - * Generated from protobuf field string merchant_account_id = 4; + * Generated from protobuf field string merchant_account_id = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/TransactionData/User.php b/RecaptchaEnterprise/src/V1/TransactionData/User.php index e13ea9258999..5e7906299b9e 100644 --- a/RecaptchaEnterprise/src/V1/TransactionData/User.php +++ b/RecaptchaEnterprise/src/V1/TransactionData/User.php @@ -16,43 +16,43 @@ class User extends \Google\Protobuf\Internal\Message { /** - * Unique account identifier for this user. If using account defender, - * this should match the hashed_account_id field. Otherwise, a unique and - * persistent identifier for this account. + * Optional. Unique account identifier for this user. If using account + * defender, this should match the hashed_account_id field. Otherwise, a + * unique and persistent identifier for this account. * - * Generated from protobuf field string account_id = 6; + * Generated from protobuf field string account_id = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $account_id = ''; /** - * The epoch milliseconds of the user's account creation. + * Optional. The epoch milliseconds of the user's account creation. * - * Generated from protobuf field int64 creation_ms = 1; + * Generated from protobuf field int64 creation_ms = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $creation_ms = 0; /** - * The email address of the user. + * Optional. The email address of the user. * - * Generated from protobuf field string email = 2; + * Generated from protobuf field string email = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $email = ''; /** - * Whether the email has been verified to be accessible by the user (OTP or - * similar). + * Optional. Whether the email has been verified to be accessible by the + * user (OTP or similar). * - * Generated from protobuf field bool email_verified = 3; + * Generated from protobuf field bool email_verified = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $email_verified = false; /** - * The phone number of the user, with country code. + * Optional. The phone number of the user, with country code. * - * Generated from protobuf field string phone_number = 4; + * Generated from protobuf field string phone_number = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $phone_number = ''; /** - * Whether the phone number has been verified to be accessible by the user - * (OTP or similar). + * Optional. Whether the phone number has been verified to be accessible by + * the user (OTP or similar). * - * Generated from protobuf field bool phone_verified = 5; + * Generated from protobuf field bool phone_verified = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $phone_verified = false; @@ -63,21 +63,21 @@ class User extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $account_id - * Unique account identifier for this user. If using account defender, - * this should match the hashed_account_id field. Otherwise, a unique and - * persistent identifier for this account. + * Optional. Unique account identifier for this user. If using account + * defender, this should match the hashed_account_id field. Otherwise, a + * unique and persistent identifier for this account. * @type int|string $creation_ms - * The epoch milliseconds of the user's account creation. + * Optional. The epoch milliseconds of the user's account creation. * @type string $email - * The email address of the user. + * Optional. The email address of the user. * @type bool $email_verified - * Whether the email has been verified to be accessible by the user (OTP or - * similar). + * Optional. Whether the email has been verified to be accessible by the + * user (OTP or similar). * @type string $phone_number - * The phone number of the user, with country code. + * Optional. The phone number of the user, with country code. * @type bool $phone_verified - * Whether the phone number has been verified to be accessible by the user - * (OTP or similar). + * Optional. Whether the phone number has been verified to be accessible by + * the user (OTP or similar). * } */ public function __construct($data = NULL) { @@ -86,11 +86,11 @@ public function __construct($data = NULL) { } /** - * Unique account identifier for this user. If using account defender, - * this should match the hashed_account_id field. Otherwise, a unique and - * persistent identifier for this account. + * Optional. Unique account identifier for this user. If using account + * defender, this should match the hashed_account_id field. Otherwise, a + * unique and persistent identifier for this account. * - * Generated from protobuf field string account_id = 6; + * Generated from protobuf field string account_id = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getAccountId() @@ -99,11 +99,11 @@ public function getAccountId() } /** - * Unique account identifier for this user. If using account defender, - * this should match the hashed_account_id field. Otherwise, a unique and - * persistent identifier for this account. + * Optional. Unique account identifier for this user. If using account + * defender, this should match the hashed_account_id field. Otherwise, a + * unique and persistent identifier for this account. * - * Generated from protobuf field string account_id = 6; + * Generated from protobuf field string account_id = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -116,9 +116,9 @@ public function setAccountId($var) } /** - * The epoch milliseconds of the user's account creation. + * Optional. The epoch milliseconds of the user's account creation. * - * Generated from protobuf field int64 creation_ms = 1; + * Generated from protobuf field int64 creation_ms = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return int|string */ public function getCreationMs() @@ -127,9 +127,9 @@ public function getCreationMs() } /** - * The epoch milliseconds of the user's account creation. + * Optional. The epoch milliseconds of the user's account creation. * - * Generated from protobuf field int64 creation_ms = 1; + * Generated from protobuf field int64 creation_ms = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param int|string $var * @return $this */ @@ -142,9 +142,9 @@ public function setCreationMs($var) } /** - * The email address of the user. + * Optional. The email address of the user. * - * Generated from protobuf field string email = 2; + * Generated from protobuf field string email = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getEmail() @@ -153,9 +153,9 @@ public function getEmail() } /** - * The email address of the user. + * Optional. The email address of the user. * - * Generated from protobuf field string email = 2; + * Generated from protobuf field string email = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -168,10 +168,10 @@ public function setEmail($var) } /** - * Whether the email has been verified to be accessible by the user (OTP or - * similar). + * Optional. Whether the email has been verified to be accessible by the + * user (OTP or similar). * - * Generated from protobuf field bool email_verified = 3; + * Generated from protobuf field bool email_verified = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getEmailVerified() @@ -180,10 +180,10 @@ public function getEmailVerified() } /** - * Whether the email has been verified to be accessible by the user (OTP or - * similar). + * Optional. Whether the email has been verified to be accessible by the + * user (OTP or similar). * - * Generated from protobuf field bool email_verified = 3; + * Generated from protobuf field bool email_verified = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -196,9 +196,9 @@ public function setEmailVerified($var) } /** - * The phone number of the user, with country code. + * Optional. The phone number of the user, with country code. * - * Generated from protobuf field string phone_number = 4; + * Generated from protobuf field string phone_number = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPhoneNumber() @@ -207,9 +207,9 @@ public function getPhoneNumber() } /** - * The phone number of the user, with country code. + * Optional. The phone number of the user, with country code. * - * Generated from protobuf field string phone_number = 4; + * Generated from protobuf field string phone_number = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -222,10 +222,10 @@ public function setPhoneNumber($var) } /** - * Whether the phone number has been verified to be accessible by the user - * (OTP or similar). + * Optional. Whether the phone number has been verified to be accessible by + * the user (OTP or similar). * - * Generated from protobuf field bool phone_verified = 5; + * Generated from protobuf field bool phone_verified = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getPhoneVerified() @@ -234,10 +234,10 @@ public function getPhoneVerified() } /** - * Whether the phone number has been verified to be accessible by the user - * (OTP or similar). + * Optional. Whether the phone number has been verified to be accessible by + * the user (OTP or similar). * - * Generated from protobuf field bool phone_verified = 5; + * Generated from protobuf field bool phone_verified = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/WebKeySettings.php b/RecaptchaEnterprise/src/V1/WebKeySettings.php index 4081c1b62476..e2769bf8c85e 100644 --- a/RecaptchaEnterprise/src/V1/WebKeySettings.php +++ b/RecaptchaEnterprise/src/V1/WebKeySettings.php @@ -16,25 +16,25 @@ class WebKeySettings extends \Google\Protobuf\Internal\Message { /** - * If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains will not be enforced. * - * Generated from protobuf field bool allow_all_domains = 3; + * Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $allow_all_domains = false; /** - * Domains or subdomains of websites allowed to use the key. All subdomains - * of an allowed domain are automatically allowed. A valid domain requires a - * host and must not include any path, port, query or fragment. + * Optional. Domains or subdomains of websites allowed to use the key. All + * subdomains of an allowed domain are automatically allowed. A valid domain + * requires a host and must not include any path, port, query or fragment. * Examples: 'example.com' or 'subdomain.example.com' * - * Generated from protobuf field repeated string allowed_domains = 1; + * Generated from protobuf field repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $allowed_domains; /** - * If set to true, the key can be used on AMP (Accelerated Mobile Pages) - * websites. This is supported only for the SCORE integration type. + * Optional. If set to true, the key can be used on AMP (Accelerated Mobile + * Pages) websites. This is supported only for the SCORE integration type. * - * Generated from protobuf field bool allow_amp_traffic = 2; + * Generated from protobuf field bool allow_amp_traffic = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $allow_amp_traffic = false; /** @@ -44,11 +44,11 @@ class WebKeySettings extends \Google\Protobuf\Internal\Message */ private $integration_type = 0; /** - * Settings for the frequency and difficulty at which this key triggers - * captcha challenges. This should only be specified for IntegrationTypes - * CHECKBOX and INVISIBLE. + * Optional. Settings for the frequency and difficulty at which this key + * triggers captcha challenges. This should only be specified for + * IntegrationTypes CHECKBOX and INVISIBLE. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $challenge_security_preference = 0; @@ -59,21 +59,21 @@ class WebKeySettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $allow_all_domains - * If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains will not be enforced. * @type array|\Google\Protobuf\Internal\RepeatedField $allowed_domains - * Domains or subdomains of websites allowed to use the key. All subdomains - * of an allowed domain are automatically allowed. A valid domain requires a - * host and must not include any path, port, query or fragment. + * Optional. Domains or subdomains of websites allowed to use the key. All + * subdomains of an allowed domain are automatically allowed. A valid domain + * requires a host and must not include any path, port, query or fragment. * Examples: 'example.com' or 'subdomain.example.com' * @type bool $allow_amp_traffic - * If set to true, the key can be used on AMP (Accelerated Mobile Pages) - * websites. This is supported only for the SCORE integration type. + * Optional. If set to true, the key can be used on AMP (Accelerated Mobile + * Pages) websites. This is supported only for the SCORE integration type. * @type int $integration_type * Required. Describes how this key is integrated with the website. * @type int $challenge_security_preference - * Settings for the frequency and difficulty at which this key triggers - * captcha challenges. This should only be specified for IntegrationTypes - * CHECKBOX and INVISIBLE. + * Optional. Settings for the frequency and difficulty at which this key + * triggers captcha challenges. This should only be specified for + * IntegrationTypes CHECKBOX and INVISIBLE. * } */ public function __construct($data = NULL) { @@ -82,9 +82,9 @@ public function __construct($data = NULL) { } /** - * If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains will not be enforced. * - * Generated from protobuf field bool allow_all_domains = 3; + * Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getAllowAllDomains() @@ -93,9 +93,9 @@ public function getAllowAllDomains() } /** - * If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains will not be enforced. * - * Generated from protobuf field bool allow_all_domains = 3; + * Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -108,12 +108,12 @@ public function setAllowAllDomains($var) } /** - * Domains or subdomains of websites allowed to use the key. All subdomains - * of an allowed domain are automatically allowed. A valid domain requires a - * host and must not include any path, port, query or fragment. + * Optional. Domains or subdomains of websites allowed to use the key. All + * subdomains of an allowed domain are automatically allowed. A valid domain + * requires a host and must not include any path, port, query or fragment. * Examples: 'example.com' or 'subdomain.example.com' * - * Generated from protobuf field repeated string allowed_domains = 1; + * Generated from protobuf field repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAllowedDomains() @@ -122,12 +122,12 @@ public function getAllowedDomains() } /** - * Domains or subdomains of websites allowed to use the key. All subdomains - * of an allowed domain are automatically allowed. A valid domain requires a - * host and must not include any path, port, query or fragment. + * Optional. Domains or subdomains of websites allowed to use the key. All + * subdomains of an allowed domain are automatically allowed. A valid domain + * requires a host and must not include any path, port, query or fragment. * Examples: 'example.com' or 'subdomain.example.com' * - * Generated from protobuf field repeated string allowed_domains = 1; + * Generated from protobuf field repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -140,10 +140,10 @@ public function setAllowedDomains($var) } /** - * If set to true, the key can be used on AMP (Accelerated Mobile Pages) - * websites. This is supported only for the SCORE integration type. + * Optional. If set to true, the key can be used on AMP (Accelerated Mobile + * Pages) websites. This is supported only for the SCORE integration type. * - * Generated from protobuf field bool allow_amp_traffic = 2; + * Generated from protobuf field bool allow_amp_traffic = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getAllowAmpTraffic() @@ -152,10 +152,10 @@ public function getAllowAmpTraffic() } /** - * If set to true, the key can be used on AMP (Accelerated Mobile Pages) - * websites. This is supported only for the SCORE integration type. + * Optional. If set to true, the key can be used on AMP (Accelerated Mobile + * Pages) websites. This is supported only for the SCORE integration type. * - * Generated from protobuf field bool allow_amp_traffic = 2; + * Generated from protobuf field bool allow_amp_traffic = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -194,11 +194,11 @@ public function setIntegrationType($var) } /** - * Settings for the frequency and difficulty at which this key triggers - * captcha challenges. This should only be specified for IntegrationTypes - * CHECKBOX and INVISIBLE. + * Optional. Settings for the frequency and difficulty at which this key + * triggers captcha challenges. This should only be specified for + * IntegrationTypes CHECKBOX and INVISIBLE. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getChallengeSecurityPreference() @@ -207,11 +207,11 @@ public function getChallengeSecurityPreference() } /** - * Settings for the frequency and difficulty at which this key triggers - * captcha challenges. This should only be specified for IntegrationTypes - * CHECKBOX and INVISIBLE. + * Optional. Settings for the frequency and difficulty at which this key + * triggers captcha challenges. This should only be specified for + * IntegrationTypes CHECKBOX and INVISIBLE. * - * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5; + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ diff --git a/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php b/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php index 8351c0914cc2..e3d812aa2fac 100644 --- a/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php +++ b/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php @@ -323,6 +323,8 @@ public function createKeyTest() // Mock request $formattedParent = $gapicClient->projectName('[PROJECT]'); $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); $request = (new CreateKeyRequest()) ->setParent($formattedParent) ->setKey($key); @@ -361,6 +363,8 @@ public function createKeyExceptionTest() // Mock request $formattedParent = $gapicClient->projectName('[PROJECT]'); $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); $request = (new CreateKeyRequest()) ->setParent($formattedParent) ->setKey($key); @@ -1276,6 +1280,8 @@ public function updateKeyTest() $transport->addResponse($expectedResponse); // Mock request $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); $request = (new UpdateKeyRequest()) ->setKey($key); $response = $gapicClient->updateKey($request); @@ -1310,6 +1316,8 @@ public function updateKeyExceptionTest() $transport->addResponse(null, $status); // Mock request $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); $request = (new UpdateKeyRequest()) ->setKey($key); try { diff --git a/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php b/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php index 2b7c30ac45fe..fd1e28080325 100644 --- a/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php +++ b/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php @@ -287,6 +287,8 @@ public function createKeyTest() // Mock request $formattedParent = $gapicClient->projectName('[PROJECT]'); $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); $response = $gapicClient->createKey($formattedParent, $key); $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); @@ -322,6 +324,8 @@ public function createKeyExceptionTest() // Mock request $formattedParent = $gapicClient->projectName('[PROJECT]'); $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); try { $gapicClient->createKey($formattedParent, $key); // If the $gapicClient method call did not throw, fail the test @@ -1182,6 +1186,8 @@ public function updateKeyTest() $transport->addResponse($expectedResponse); // Mock request $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); $response = $gapicClient->updateKey($key); $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); @@ -1214,6 +1220,8 @@ public function updateKeyExceptionTest() $transport->addResponse(null, $status); // Mock request $key = new Key(); + $keyDisplayName = 'keyDisplayName-302940530'; + $key->setDisplayName($keyDisplayName); try { $gapicClient->updateKey($key); // If the $gapicClient method call did not throw, fail the test