From ca2ba787e1da16e1de330d409fcfb0f1338a3b01 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Mon, 11 Nov 2024 12:14:06 -0800 Subject: [PATCH] chore(tests): update GAPIC fixtures for latest updates (#7819) --- .../V1.Client.SecretManagerServiceClient.yml | 1040 +++- dev/tests/fixtures/docfx/NewClient/toc.yml | 13 +- .../V1.AsyncBatchAnnotateFilesRequest.yml | 49 + .../V1.AsyncBatchAnnotateImagesRequest.yml | 49 + .../Vision/V1.BatchAnnotateFilesRequest.yml | 61 +- .../Vision/V1.BatchAnnotateImagesRequest.yml | 49 + .../Vision/V1.BatchOperationMetadata.yml | 6 +- dev/tests/fixtures/docfx/Vision/V1.Block.yml | 2 +- .../Vision/V1.Client.ImageAnnotatorClient.yml | 177 +- .../Vision/V1.Client.ProductSearchClient.yml | 997 +++- .../Vision/V1.CreateReferenceImageRequest.yml | 9 +- .../docfx/Vision/V1.GcsDestination.yml | 2 +- .../docfx/Vision/V1.ImageAnnotatorClient.yml | 564 --- .../Vision/V1.ImportProductSetsGcsSource.yml | 20 +- .../Vision/V1.ImportProductSetsResponse.yml | 6 +- .../fixtures/docfx/Vision/V1.Paragraph.yml | 2 +- .../fixtures/docfx/Vision/V1.Product.yml | 20 +- .../docfx/Vision/V1.ProductSearchClient.yml | 2066 -------- .../docfx/Vision/V1.ProductSearchParams.yml | 6 +- .../docfx/Vision/V1.ReferenceImage.yml | 12 +- .../V1.RemoveProductFromProductSetRequest.yml | 9 +- .../docfx/Vision/V1.SafeSearchAnnotation.yml | 12 +- dev/tests/fixtures/docfx/Vision/V1.Symbol.yml | 2 +- .../docfx/Vision/V1.TextAnnotation.yml | 5 +- .../docfx/Vision/V1.TextDetectionParams.yml | 20 +- .../docfx/Vision/V1.WebDetectionParams.yml | 6 +- dev/tests/fixtures/docfx/Vision/V1.Word.yml | 2 +- dev/tests/fixtures/docfx/Vision/toc.yml | 2 - dev/tests/fixtures/phpdoc/newclient.xml | 3824 ++++++++++++--- dev/tests/fixtures/phpdoc/structure.xml | 4202 +++++++++-------- 30 files changed, 7612 insertions(+), 5622 deletions(-) diff --git a/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml b/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml index e188faded5e4..9d7bfdedd26c 100644 --- a/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml +++ b/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml @@ -21,10 +21,6 @@ items: assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API. - - This class is currently experimental and may be subject to changes. See Google\Cloud\SecretManager\V1\SecretManagerServiceClient for the stable - implementation - status: beta type: class namespace: 'Google \ Cloud \ SecretManager \ V1 \ Client' langs: @@ -61,7 +57,12 @@ items: - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicyAsync()' - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::testIamPermissionsAsync()' - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecretAsync()' + - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::locationName()' - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectName()' + - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectLocationSecretName()' + - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectLocationSecretSecretVersionName()' + - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectSecretName()' + - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectSecretSecretVersionName()' - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::secretName()' - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::secretVersionName()' - '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::topicName()' @@ -118,7 +119,9 @@ items: name: accessSecretVersion id: accessSecretVersion summary: |- - Accesses a SecretVersion. This call returns the secret data. + Accesses a SecretVersion. + + This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. @@ -129,6 +132,65 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\AccessSecretVersionRequest; + use Google\Cloud\SecretManager\V1\AccessSecretVersionResponse; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + + /** + * @param string $formattedName The resource name of the + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format + * `projects/*/secrets/*/versions/*` or + * `projects/*/locations/*/secrets/*/versions/*`. + * + * `projects/*/secrets/*/versions/latest` or + * `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most + * recently created + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Please see + * {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field. + */ + function access_secret_version_sample(string $formattedName): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new AccessSecretVersionRequest()) + ->setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var AccessSecretVersionResponse $response */ + $response = $secretManagerServiceClient->accessSecretVersion($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = SecretManagerServiceClient::secretVersionName( + '[PROJECT]', + '[SECRET]', + '[SECRET_VERSION]' + ); + + access_secret_version_sample($formattedName); + } + ``` syntax: parameters: - @@ -151,8 +213,9 @@ items: name: addSecretVersion id: addSecretVersion summary: |- - Creates a new SecretVersion containing secret data and attaches - it to an existing Secret. + Creates a new SecretVersion + containing secret data and attaches it to an existing + Secret. The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::addSecretVersionAsync() . @@ -160,6 +223,59 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\AddSecretVersionRequest; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\SecretPayload; + use Google\Cloud\SecretManager\V1\SecretVersion; + + /** + * @param string $formattedParent The resource name of the + * [Secret][google.cloud.secretmanager.v1.Secret] to associate with the + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format + * `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. Please see + * {@see SecretManagerServiceClient::secretName()} for help formatting this field. + */ + function add_secret_version_sample(string $formattedParent): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $payload = new SecretPayload(); + $request = (new AddSecretVersionRequest()) + ->setParent($formattedParent) + ->setPayload($payload); + + // Call the API and handle any network failures. + try { + /** @var SecretVersion $response */ + $response = $secretManagerServiceClient->addSecretVersion($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedParent = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]'); + + add_secret_version_sample($formattedParent); + } + ``` syntax: parameters: - @@ -182,13 +298,72 @@ items: name: createSecret id: createSecret summary: |- - Creates a new Secret containing no SecretVersions. + Creates a new Secret containing no + SecretVersions. The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::createSecretAsync() . parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\CreateSecretRequest; + use Google\Cloud\SecretManager\V1\Secret; + + /** + * @param string $formattedParent The resource name of the project to associate with the + * [Secret][google.cloud.secretmanager.v1.Secret], in the format `projects/*` + * or `projects/*/locations/*`. Please see + * {@see SecretManagerServiceClient::projectName()} for help formatting this field. + * @param string $secretId This must be unique within the project. + * + * A secret ID is a string with a maximum length of 255 characters and can + * contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and + * underscore (`_`) characters. + */ + function create_secret_sample(string $formattedParent, string $secretId): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $secret = new Secret(); + $request = (new CreateSecretRequest()) + ->setParent($formattedParent) + ->setSecretId($secretId) + ->setSecret($secret); + + // Call the API and handle any network failures. + try { + /** @var Secret $response */ + $response = $secretManagerServiceClient->createSecret($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedParent = SecretManagerServiceClient::projectName('[PROJECT]'); + $secretId = '[SECRET_ID]'; + + create_secret_sample($formattedParent, $secretId); + } + ``` syntax: parameters: - @@ -218,6 +393,53 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\DeleteSecretRequest; + + /** + * @param string $formattedName The resource name of the + * [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format + * `projects/*/secrets/*`. Please see + * {@see SecretManagerServiceClient::secretName()} for help formatting this field. + */ + function delete_secret_sample(string $formattedName): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new DeleteSecretRequest()) + ->setName($formattedName); + + // Call the API and handle any network failures. + try { + $secretManagerServiceClient->deleteSecret($request); + printf('Call completed successfully.' . PHP_EOL); + } catch (ApiException $ex) { + 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 + { + $formattedName = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]'); + + delete_secret_sample($formattedName); + } + ``` syntax: parameters: - @@ -239,9 +461,10 @@ items: summary: |- Destroys a SecretVersion. - Sets the state of the SecretVersion to - DESTROYED and irrevocably destroys the - secret data. + Sets the state of the + SecretVersion to + DESTROYED + and irrevocably destroys the secret data. The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::destroySecretVersionAsync() . @@ -249,6 +472,60 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\DestroySecretVersionRequest; + use Google\Cloud\SecretManager\V1\SecretVersion; + + /** + * @param string $formattedName The resource name of the + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in + * the format `projects/*/secrets/*/versions/*` or + * `projects/*/locations/*/secrets/*/versions/*`. Please see + * {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field. + */ + function destroy_secret_version_sample(string $formattedName): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new DestroySecretVersionRequest()) + ->setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var SecretVersion $response */ + $response = $secretManagerServiceClient->destroySecretVersion($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = SecretManagerServiceClient::secretVersionName( + '[PROJECT]', + '[SECRET]', + '[SECRET_VERSION]' + ); + + destroy_secret_version_sample($formattedName); + } + ``` syntax: parameters: - @@ -273,7 +550,8 @@ items: summary: |- Disables a SecretVersion. - Sets the state of the SecretVersion to + Sets the state of the + SecretVersion to DISABLED. The async variant is @@ -282,6 +560,60 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\DisableSecretVersionRequest; + use Google\Cloud\SecretManager\V1\SecretVersion; + + /** + * @param string $formattedName The resource name of the + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in + * the format `projects/*/secrets/*/versions/*` or + * `projects/*/locations/*/secrets/*/versions/*`. Please see + * {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field. + */ + function disable_secret_version_sample(string $formattedName): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new DisableSecretVersionRequest()) + ->setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var SecretVersion $response */ + $response = $secretManagerServiceClient->disableSecretVersion($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = SecretManagerServiceClient::secretVersionName( + '[PROJECT]', + '[SECRET]', + '[SECRET_VERSION]' + ); + + disable_secret_version_sample($formattedName); + } + ``` syntax: parameters: - @@ -306,7 +638,8 @@ items: summary: |- Enables a SecretVersion. - Sets the state of the SecretVersion to + Sets the state of the + SecretVersion to ENABLED. The async variant is @@ -315,6 +648,60 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\EnableSecretVersionRequest; + use Google\Cloud\SecretManager\V1\SecretVersion; + + /** + * @param string $formattedName The resource name of the + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in + * the format `projects/*/secrets/*/versions/*` or + * `projects/*/locations/*/secrets/*/versions/*`. Please see + * {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field. + */ + function enable_secret_version_sample(string $formattedName): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new EnableSecretVersionRequest()) + ->setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var SecretVersion $response */ + $response = $secretManagerServiceClient->enableSecretVersion($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = SecretManagerServiceClient::secretVersionName( + '[PROJECT]', + '[SECRET]', + '[SECRET_VERSION]' + ); + + enable_secret_version_sample($formattedName); + } + ``` syntax: parameters: - @@ -346,6 +733,53 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Iam\V1\GetIamPolicyRequest; + use Google\Cloud\Iam\V1\Policy; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + + /** + * @param string $resource REQUIRED: The resource for which the policy is being requested. + * See the operation documentation for the appropriate value for this field. + */ + function get_iam_policy_sample(string $resource): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new GetIamPolicyRequest()) + ->setResource($resource); + + // Call the API and handle any network failures. + try { + /** @var Policy $response */ + $response = $secretManagerServiceClient->getIamPolicy($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $resource = '[RESOURCE]'; + + get_iam_policy_sample($resource); + } + ``` syntax: parameters: - @@ -375,6 +809,55 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\GetSecretRequest; + use Google\Cloud\SecretManager\V1\Secret; + + /** + * @param string $formattedName The resource name of the + * [Secret][google.cloud.secretmanager.v1.Secret], in the format + * `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. Please see + * {@see SecretManagerServiceClient::secretName()} for help formatting this field. + */ + function get_secret_sample(string $formattedName): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new GetSecretRequest()) + ->setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Secret $response */ + $response = $secretManagerServiceClient->getSecret($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]'); + + get_secret_sample($formattedName); + } + ``` syntax: parameters: - @@ -397,7 +880,8 @@ items: name: getSecretVersion id: getSecretVersion summary: |- - Gets metadata for a SecretVersion. + Gets metadata for a + SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. @@ -408,6 +892,65 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\GetSecretVersionRequest; + use Google\Cloud\SecretManager\V1\SecretVersion; + + /** + * @param string $formattedName The resource name of the + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format + * `projects/*/secrets/*/versions/*` or + * `projects/*/locations/*/secrets/*/versions/*`. + * + * `projects/*/secrets/*/versions/latest` or + * `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most + * recently created + * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Please see + * {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field. + */ + function get_secret_version_sample(string $formattedName): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new GetSecretVersionRequest()) + ->setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var SecretVersion $response */ + $response = $secretManagerServiceClient->getSecretVersion($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = SecretManagerServiceClient::secretVersionName( + '[PROJECT]', + '[SECRET]', + '[SECRET_VERSION]' + ); + + get_secret_version_sample($formattedName); + } + ``` syntax: parameters: - @@ -430,8 +973,8 @@ items: name: listSecretVersions id: listSecretVersions summary: |- - Lists SecretVersions. This call does not return secret - data. + Lists SecretVersions. This + call does not return secret data. The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretVersionsAsync() . @@ -439,6 +982,61 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\PagedListResponse; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\ListSecretVersionsRequest; + use Google\Cloud\SecretManager\V1\SecretVersion; + + /** + * @param string $formattedParent The resource name of the + * [Secret][google.cloud.secretmanager.v1.Secret] associated with the + * [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] to list, in + * the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. Please see + * {@see SecretManagerServiceClient::secretName()} for help formatting this field. + */ + function list_secret_versions_sample(string $formattedParent): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new ListSecretVersionsRequest()) + ->setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $secretManagerServiceClient->listSecretVersions($request); + + /** @var SecretVersion $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedParent = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]'); + + list_secret_versions_sample($formattedParent); + } + ``` syntax: parameters: - @@ -468,6 +1066,60 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\PagedListResponse; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\ListSecretsRequest; + use Google\Cloud\SecretManager\V1\Secret; + + /** + * @param string $formattedParent The resource name of the project associated with the + * [Secrets][google.cloud.secretmanager.v1.Secret], in the format `projects/*` + * or `projects/*/locations/*` + * Please see {@see SecretManagerServiceClient::projectName()} for help formatting this field. + */ + function list_secrets_sample(string $formattedParent): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $request = (new ListSecretsRequest()) + ->setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $secretManagerServiceClient->listSecrets($request); + + /** @var Secret $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedParent = SecretManagerServiceClient::projectName('[PROJECT]'); + + list_secrets_sample($formattedParent); + } + ``` syntax: parameters: - @@ -493,14 +1145,65 @@ items: Sets the access control policy on the specified secret. Replaces any existing policy. - Permissions on SecretVersions are enforced according - to the policy set on the associated Secret. + Permissions on + SecretVersions are enforced + according to the policy set on the associated + Secret. The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicyAsync() . parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Iam\V1\Policy; + use Google\Cloud\Iam\V1\SetIamPolicyRequest; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + + /** + * @param string $resource REQUIRED: The resource for which the policy is being specified. + * See the operation documentation for the appropriate value for this field. + */ + function set_iam_policy_sample(string $resource): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $policy = new Policy(); + $request = (new SetIamPolicyRequest()) + ->setResource($resource) + ->setPolicy($policy); + + // Call the API and handle any network failures. + try { + /** @var Policy $response */ + $response = $secretManagerServiceClient->setIamPolicy($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $resource = '[RESOURCE]'; + + set_iam_policy_sample($resource); + } + ``` syntax: parameters: - @@ -538,6 +1241,60 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Iam\V1\TestIamPermissionsRequest; + use Google\Cloud\Iam\V1\TestIamPermissionsResponse; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + + /** + * @param string $resource REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. For more + * information see + * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + function test_iam_permissions_sample(string $resource, string $permissionsElement): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $permissions = [$permissionsElement,]; + $request = (new TestIamPermissionsRequest()) + ->setResource($resource) + ->setPermissions($permissions); + + // Call the API and handle any network failures. + try { + /** @var TestIamPermissionsResponse $response */ + $response = $secretManagerServiceClient->testIamPermissions($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $resource = '[RESOURCE]'; + $permissionsElement = '[PERMISSIONS]'; + + test_iam_permissions_sample($resource, $permissionsElement); + } + ``` syntax: parameters: - @@ -560,13 +1317,52 @@ items: name: updateSecret id: updateSecret summary: |- - Updates metadata of an existing Secret. + Updates metadata of an existing + Secret. The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecretAsync() . parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient; + use Google\Cloud\SecretManager\V1\Secret; + use Google\Cloud\SecretManager\V1\UpdateSecretRequest; + use Google\Protobuf\FieldMask; + + /** + * 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 update_secret_sample(): void + { + // Create a client. + $secretManagerServiceClient = new SecretManagerServiceClient(); + + // Prepare the request message. + $secret = new Secret(); + $updateMask = new FieldMask(); + $request = (new UpdateSecretRequest()) + ->setSecret($secret) + ->setUpdateMask($updateMask); + + // Call the API and handle any network failures. + try { + /** @var Secret $response */ + $response = $secretManagerServiceClient->updateSecret($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } + } + ``` syntax: parameters: - @@ -599,12 +1395,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\AccessSecretVersionRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\AccessSecretVersionResponse>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::addSecretVersionAsync()' name: addSecretVersionAsync @@ -620,12 +1416,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\AddSecretVersionRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\SecretVersion>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::createSecretAsync()' name: createSecretAsync @@ -641,12 +1437,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\CreateSecretRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\Secret>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::deleteSecretAsync()' name: deleteSecretAsync @@ -662,12 +1458,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\DeleteSecretRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<void>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::destroySecretVersionAsync()' name: destroySecretVersionAsync @@ -683,12 +1479,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\DestroySecretVersionRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\SecretVersion>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::disableSecretVersionAsync()' name: disableSecretVersionAsync @@ -704,12 +1500,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\DisableSecretVersionRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\SecretVersion>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::enableSecretVersionAsync()' name: enableSecretVersionAsync @@ -725,12 +1521,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\EnableSecretVersionRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\SecretVersion>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getIamPolicyAsync()' name: getIamPolicyAsync @@ -746,12 +1542,12 @@ items: var_type: 'Google\Cloud\Iam\V1\GetIamPolicyRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretAsync()' name: getSecretAsync @@ -767,12 +1563,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\GetSecretRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\Secret>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretVersionAsync()' name: getSecretVersionAsync @@ -788,12 +1584,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\GetSecretVersionRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\SecretVersion>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretVersionsAsync()' name: listSecretVersionsAsync @@ -809,12 +1605,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\ListSecretVersionsRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretsAsync()' name: listSecretsAsync @@ -830,12 +1626,12 @@ items: var_type: 'Google\Cloud\SecretManager\V1\ListSecretsRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicyAsync()' name: setIamPolicyAsync @@ -851,12 +1647,12 @@ items: var_type: 'Google\Cloud\Iam\V1\SetIamPolicyRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::testIamPermissionsAsync()' name: testIamPermissionsAsync @@ -872,12 +1668,12 @@ items: var_type: 'Google\Cloud\Iam\V1\TestIamPermissionsRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse>' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecretAsync()' name: updateSecretAsync @@ -893,12 +1689,37 @@ items: var_type: 'Google\Cloud\SecretManager\V1\UpdateSecretRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SecretManager\V1\Secret>' + - + uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::locationName()' + name: 'static::locationName' + id: locationName + summary: |- + Formats a string containing the fully-qualified path to represent a location + resource. + parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient + type: method + langs: + - php + syntax: + parameters: + - + id: project + var_type: string + description: '' + - + id: location + var_type: string + description: '' + returns: + - + var_type: string + description: 'The formatted location resource.' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectName()' name: 'static::projectName' @@ -920,6 +1741,122 @@ items: - var_type: string description: 'The formatted project resource.' + - + uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectLocationSecretName()' + name: 'static::projectLocationSecretName' + id: projectLocationSecretName + summary: |- + Formats a string containing the fully-qualified path to represent a + project_location_secret resource. + parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient + type: method + langs: + - php + syntax: + parameters: + - + id: project + var_type: string + description: '' + - + id: location + var_type: string + description: '' + - + id: secret + var_type: string + description: '' + returns: + - + var_type: string + description: 'The formatted project_location_secret resource.' + - + uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectLocationSecretSecretVersionName()' + name: 'static::projectLocationSecretSecretVersionName' + id: projectLocationSecretSecretVersionName + summary: |- + Formats a string containing the fully-qualified path to represent a + project_location_secret_secret_version resource. + parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient + type: method + langs: + - php + syntax: + parameters: + - + id: project + var_type: string + description: '' + - + id: location + var_type: string + description: '' + - + id: secret + var_type: string + description: '' + - + id: secretVersion + var_type: string + description: '' + returns: + - + var_type: string + description: 'The formatted project_location_secret_secret_version resource.' + - + uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectSecretName()' + name: 'static::projectSecretName' + id: projectSecretName + summary: |- + Formats a string containing the fully-qualified path to represent a + project_secret resource. + parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient + type: method + langs: + - php + syntax: + parameters: + - + id: project + var_type: string + description: '' + - + id: secret + var_type: string + description: '' + returns: + - + var_type: string + description: 'The formatted project_secret resource.' + - + uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectSecretSecretVersionName()' + name: 'static::projectSecretSecretVersionName' + id: projectSecretSecretVersionName + summary: |- + Formats a string containing the fully-qualified path to represent a + project_secret_secret_version resource. + parent: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient + type: method + langs: + - php + syntax: + parameters: + - + id: project + var_type: string + description: '' + - + id: secret + var_type: string + description: '' + - + id: secretVersion + var_type: string + description: '' + returns: + - + var_type: string + description: 'The formatted project_secret_secret_version resource.' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::secretName()' name: 'static::secretName' @@ -1008,7 +1945,12 @@ items: The following name formats are supported: Template: Pattern + - location: projects/{project}/locations/{location} - project: projects/{project} + - projectLocationSecret: projects/{project}/locations/{location}/secrets/{secret} + - projectLocationSecretSecretVersion: projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version} + - projectSecret: projects/{project}/secrets/{secret} + - projectSecretSecretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - secret: projects/{project}/secrets/{secret} - secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - topic: projects/{project}/topics/{topic} diff --git a/dev/tests/fixtures/docfx/NewClient/toc.yml b/dev/tests/fixtures/docfx/NewClient/toc.yml index 7154dc05c0d3..b0a5e8d965b9 100644 --- a/dev/tests/fixtures/docfx/NewClient/toc.yml +++ b/dev/tests/fixtures/docfx/NewClient/toc.yml @@ -19,7 +19,6 @@ - uid: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient name: 'SecretManagerServiceClient (beta)' - status: beta - name: V1beta1 uid: 'ns:Google\Cloud\SecretManager\V1beta1' @@ -32,3 +31,15 @@ uid: \Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient name: SecretManagerServiceClient status: beta + - + name: V1beta2 + uid: 'ns:Google\Cloud\SecretManager\V1beta2' + items: + - + name: Services + uid: 'services:Google\Cloud\SecretManager\V1beta2' + items: + - + uid: \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient + name: 'SecretManagerServiceClient (beta)' + status: beta diff --git a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml index c56bf1c01de2..7fc9415afc64 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml @@ -20,6 +20,8 @@ items: - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setRequests()' - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getParent()' - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setParent()' + - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getLabels()' + - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setLabels()' - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::build()' - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::__construct()' @@ -44,6 +46,10 @@ items: id: '↳ parent' var_type: string description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' + - + id: '↳ labels' + var_type: 'array|Google\Protobuf\Internal\MapField' + description: 'Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.' - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getRequests()' name: getRequests @@ -124,6 +130,49 @@ items: returns: - var_type: $this + - + uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getLabels()' + name: getLabels + id: getLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest + type: method + langs: + - php + syntax: + returns: + - + var_type: 'Google\Protobuf\Internal\MapField' + - + uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setLabels()' + name: setLabels + id: setLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest + type: method + langs: + - php + syntax: + parameters: + - + id: var + var_type: 'array|Google\Protobuf\Internal\MapField' + description: '' + returns: + - + var_type: $this - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::build()' name: 'static::build' diff --git a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml index ab41fad5d0a8..7bb71d6f9c66 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml @@ -23,6 +23,8 @@ items: - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setOutputConfig()' - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getParent()' - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setParent()' + - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getLabels()' + - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setLabels()' - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::build()' - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::__construct()' @@ -51,6 +53,10 @@ items: id: '↳ parent' var_type: string description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' + - + id: '↳ labels' + var_type: 'array|Google\Protobuf\Internal\MapField' + description: 'Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.' - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getRequests()' name: getRequests @@ -178,6 +184,49 @@ items: returns: - var_type: $this + - + uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getLabels()' + name: getLabels + id: getLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest + type: method + langs: + - php + syntax: + returns: + - + var_type: 'Google\Protobuf\Internal\MapField' + - + uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setLabels()' + name: setLabels + id: setLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest + type: method + langs: + - php + syntax: + parameters: + - + id: var + var_type: 'array|Google\Protobuf\Internal\MapField' + description: '' + returns: + - + var_type: $this - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::build()' name: 'static::build' diff --git a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml index 158dad6e67cc..ecf2359024c2 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml @@ -19,6 +19,8 @@ items: - '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setRequests()' - '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getParent()' - '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setParent()' + - '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getLabels()' + - '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setLabels()' - '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::build()' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::__construct()' @@ -43,13 +45,17 @@ items: id: '↳ parent' var_type: string description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' + - + id: '↳ labels' + var_type: 'array|Google\Protobuf\Internal\MapField' + description: 'Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getRequests()' name: getRequests id: getRequests summary: |- - Required. The list of file annotation requests. Right now we support only one - AnnotateFileRequest in BatchAnnotateFilesRequest. + Required. The list of file annotation requests. Right now we support only + one AnnotateFileRequest in BatchAnnotateFilesRequest. parent: \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest type: method langs: @@ -63,8 +69,8 @@ items: name: setRequests id: setRequests summary: |- - Required. The list of file annotation requests. Right now we support only one - AnnotateFileRequest in BatchAnnotateFilesRequest. + Required. The list of file annotation requests. Right now we support only + one AnnotateFileRequest in BatchAnnotateFilesRequest. parent: \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest type: method langs: @@ -127,6 +133,49 @@ items: returns: - var_type: $this + - + uid: '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getLabels()' + name: getLabels + id: getLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest + type: method + langs: + - php + syntax: + returns: + - + var_type: 'Google\Protobuf\Internal\MapField' + - + uid: '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setLabels()' + name: setLabels + id: setLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest + type: method + langs: + - php + syntax: + parameters: + - + id: var + var_type: 'array|Google\Protobuf\Internal\MapField' + description: '' + returns: + - + var_type: $this - uid: '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::build()' name: 'static::build' @@ -141,8 +190,8 @@ items: id: requests var_type: 'array<Google\Cloud\Vision\V1\AnnotateFileRequest>' description: |- - Required. The list of file annotation requests. Right now we support only one - AnnotateFileRequest in BatchAnnotateFilesRequest. + Required. The list of file annotation requests. Right now we support only + one AnnotateFileRequest in BatchAnnotateFilesRequest. returns: - var_type: 'Google\Cloud\Vision\V1\BatchAnnotateFilesRequest' diff --git a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml index 742eeb0f08fb..c7380896a0d2 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml @@ -19,6 +19,8 @@ items: - '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setRequests()' - '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getParent()' - '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setParent()' + - '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getLabels()' + - '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setLabels()' - '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::build()' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::__construct()' @@ -43,6 +45,10 @@ items: id: '↳ parent' var_type: string description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' + - + id: '↳ labels' + var_type: 'array|Google\Protobuf\Internal\MapField' + description: 'Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getRequests()' name: getRequests @@ -123,6 +129,49 @@ items: returns: - var_type: $this + - + uid: '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getLabels()' + name: getLabels + id: getLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest + type: method + langs: + - php + syntax: + returns: + - + var_type: 'Google\Protobuf\Internal\MapField' + - + uid: '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setLabels()' + name: setLabels + id: setLabels + summary: |- + Optional. The labels with user-defined metadata for the request. + + Label keys and values can be no longer than 63 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are allowed. + Label values are optional. Label keys must start with a letter. + parent: \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest + type: method + langs: + - php + syntax: + parameters: + - + id: var + var_type: 'array|Google\Protobuf\Internal\MapField' + description: '' + returns: + - + var_type: $this - uid: '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::build()' name: 'static::build' diff --git a/dev/tests/fixtures/docfx/Vision/V1.BatchOperationMetadata.yml b/dev/tests/fixtures/docfx/Vision/V1.BatchOperationMetadata.yml index 688d1ce462e7..d23e5c0a7bc2 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BatchOperationMetadata.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BatchOperationMetadata.yml @@ -139,7 +139,8 @@ items: id: getEndTime summary: |- The time when the batch request is finished and - google.longrunning.Operation.done is set to true. + google.longrunning.Operation.done is + set to true. parent: \Google\Cloud\Vision\V1\BatchOperationMetadata type: method langs: @@ -170,7 +171,8 @@ items: id: setEndTime summary: |- The time when the batch request is finished and - google.longrunning.Operation.done is set to true. + google.longrunning.Operation.done is + set to true. parent: \Google\Cloud\Vision\V1\BatchOperationMetadata type: method langs: diff --git a/dev/tests/fixtures/docfx/Vision/V1.Block.yml b/dev/tests/fixtures/docfx/Vision/V1.Block.yml index 59d594ef53c9..d7726cb0290b 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Block.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Block.yml @@ -51,7 +51,7 @@ items: - id: '↳ bounding_box' var_type: 'Google\Cloud\Vision\V1\BoundingPoly' - description: "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." + description: "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * * when the text is horizontal it might look like: 0----1 | | 3----2 * * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." - id: '↳ paragraphs' var_type: 'array<Google\Cloud\Vision\V1\Paragraph>' diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml index 5761cda21338..b9a55162d897 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml @@ -17,9 +17,6 @@ items: assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API. - - This class is currently experimental and may be subject to changes. See Google\Cloud\Vision\V1\ImageAnnotatorClient for the stable implementation - status: beta type: class namespace: 'Google \ Cloud \ Vision \ V1 \ Client' langs: @@ -104,6 +101,51 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\OperationResponse; + use Google\Cloud\Vision\V1\AsyncAnnotateFileRequest; + use Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse; + use Google\Cloud\Vision\V1\ImageAnnotatorClient; + use Google\Rpc\Status; + + /** + * 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 async_batch_annotate_files_sample(): void + { + // Create a client. + $imageAnnotatorClient = new ImageAnnotatorClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $requests = [new AsyncAnnotateFileRequest()]; + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var AsyncBatchAnnotateFilesResponse $result */ + $result = $response->getResult(); + printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString()); + } else { + /** @var Status $error */ + $error = $response->getError(); + printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); + } + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } + } + ``` syntax: parameters: - @@ -142,6 +184,53 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\OperationResponse; + use Google\Cloud\Vision\V1\AnnotateImageRequest; + use Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse; + use Google\Cloud\Vision\V1\ImageAnnotatorClient; + use Google\Cloud\Vision\V1\OutputConfig; + use Google\Rpc\Status; + + /** + * 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 async_batch_annotate_images_sample(): void + { + // Create a client. + $imageAnnotatorClient = new ImageAnnotatorClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $requests = [new AnnotateImageRequest()]; + $outputConfig = new OutputConfig(); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $imageAnnotatorClient->asyncBatchAnnotateImages($requests, $outputConfig); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var AsyncBatchAnnotateImagesResponse $result */ + $result = $response->getResult(); + printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString()); + } else { + /** @var Status $error */ + $error = $response->getError(); + printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); + } + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } + } + ``` syntax: parameters: - @@ -178,6 +267,39 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\AnnotateFileRequest; + use Google\Cloud\Vision\V1\BatchAnnotateFilesResponse; + use Google\Cloud\Vision\V1\ImageAnnotatorClient; + + /** + * 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 batch_annotate_files_sample(): void + { + // Create a client. + $imageAnnotatorClient = new ImageAnnotatorClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $requests = [new AnnotateFileRequest()]; + + // Call the API and handle any network failures. + try { + /** @var BatchAnnotateFilesResponse $response */ + $response = $imageAnnotatorClient->batchAnnotateFiles($requests); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } + } + ``` syntax: parameters: - @@ -207,6 +329,39 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\AnnotateImageRequest; + use Google\Cloud\Vision\V1\BatchAnnotateImagesResponse; + use Google\Cloud\Vision\V1\ImageAnnotatorClient; + + /** + * 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 batch_annotate_images_sample(): void + { + // Create a client. + $imageAnnotatorClient = new ImageAnnotatorClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $requests = [new AnnotateImageRequest()]; + + // Call the API and handle any network failures. + try { + /** @var BatchAnnotateImagesResponse $response */ + $response = $imageAnnotatorClient->batchAnnotateImages($requests); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } + } + ``` syntax: parameters: - @@ -239,12 +394,12 @@ items: var_type: 'Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImagesAsync()' name: asyncBatchAnnotateImagesAsync @@ -260,12 +415,12 @@ items: var_type: 'Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFilesAsync()' name: batchAnnotateFilesAsync @@ -281,12 +436,12 @@ items: var_type: 'Google\Cloud\Vision\V1\BatchAnnotateFilesRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\BatchAnnotateFilesResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImagesAsync()' name: batchAnnotateImagesAsync @@ -302,12 +457,12 @@ items: var_type: 'Google\Cloud\Vision\V1\BatchAnnotateImagesRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\BatchAnnotateImagesResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getOperationsClient()' name: getOperationsClient diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml index 24301054c2f2..218f27011991 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml @@ -9,16 +9,18 @@ items: Service Description: Manages Products and ProductSets of reference images for use in product search. It uses the following resource model: - - The API has a collection of ProductSet resources, named - `projects/*/locations/*/productSets/*`, which acts as a way to put different - products into groups to limit identification. + - The API has a collection of ProductSet + resources, named `projects/*/locations/*/productSets/*`, which acts as a way + to put different products into groups to limit identification. In parallel, - - The API has a collection of Product resources, named + - The API has a collection of Product + resources, named `projects/*/locations/*/products/*` - - Each Product has a collection of ReferenceImage resources, named + - Each Product has a collection of + ReferenceImage resources, named `projects/*/locations/*/products/*/referenceImages/*` This class provides the ability to make remote calls to the backing service through method @@ -28,9 +30,6 @@ items: assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API. - - This class is currently experimental and may be subject to changes. See Google\Cloud\Vision\V1\ProductSearchClient for the stable implementation - status: beta type: class namespace: 'Google \ Cloud \ Vision \ V1 \ Client' langs: @@ -148,6 +147,55 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedName The resource name for the ProductSet to modify. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. + * @param string $formattedProduct The resource name for the Product to be added to this ProductSet. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Please see {@see ProductSearchClient::productName()} for help formatting this field. + */ + function add_product_to_product_set_sample(string $formattedName, string $formattedProduct): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + $productSearchClient->addProductToProductSet($formattedName, $formattedProduct); + printf('Call completed successfully.' . PHP_EOL); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); + $formattedProduct = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); + + add_product_to_product_set_sample($formattedName, $formattedProduct); + } + ``` syntax: parameters: - @@ -181,6 +229,54 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\Product; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedParent The project in which the Product should be created. + * + * Format is + * `projects/PROJECT_ID/locations/LOC_ID`. Please see + * {@see ProductSearchClient::locationName()} for help formatting this field. + */ + function create_product_sample(string $formattedParent): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $product = new Product(); + + // Call the API and handle any network failures. + try { + /** @var Product $response */ + $response = $productSearchClient->createProduct($formattedParent, $product); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); + + create_product_sample($formattedParent); + } + ``` syntax: parameters: - @@ -215,6 +311,53 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Cloud\Vision\V1\ProductSet; + + /** + * @param string $formattedParent The project in which the ProductSet should be created. + * + * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see + * {@see ProductSearchClient::locationName()} for help formatting this field. + */ + function create_product_set_sample(string $formattedParent): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $productSet = new ProductSet(); + + // Call the API and handle any network failures. + try { + /** @var ProductSet $response */ + $response = $productSearchClient->createProductSet($formattedParent, $productSet); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); + + create_product_set_sample($formattedParent); + } + ``` syntax: parameters: - @@ -262,6 +405,59 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Cloud\Vision\V1\ReferenceImage; + + /** + * @param string $formattedParent Resource name of the product in which to create the reference image. + * + * Format is + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. Please see + * {@see ProductSearchClient::productName()} for help formatting this field. + * @param string $referenceImageUri The Google Cloud Storage URI of the reference image. + * + * The URI must start with `gs://`. + */ + function create_reference_image_sample(string $formattedParent, string $referenceImageUri): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $referenceImage = (new ReferenceImage()) + ->setUri($referenceImageUri); + + // Call the API and handle any network failures. + try { + /** @var ReferenceImage $response */ + $response = $productSearchClient->createReferenceImage($formattedParent, $referenceImage); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); + $referenceImageUri = '[URI]'; + + create_reference_image_sample($formattedParent, $referenceImageUri); + } + ``` syntax: parameters: - @@ -295,6 +491,49 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedName Resource name of product to delete. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Please see {@see ProductSearchClient::productName()} for help formatting this field. + */ + function delete_product_sample(string $formattedName): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + $productSearchClient->deleteProduct($formattedName); + printf('Call completed successfully.' . PHP_EOL); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); + + delete_product_sample($formattedName); + } + ``` syntax: parameters: - @@ -324,6 +563,49 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedName Resource name of the ProductSet to delete. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. + */ + function delete_product_set_sample(string $formattedName): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + $productSearchClient->deleteProductSet($formattedName); + printf('Call completed successfully.' . PHP_EOL); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); + + delete_product_set_sample($formattedName); + } + ``` syntax: parameters: - @@ -356,6 +638,54 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedName The resource name of the reference image to delete. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * Please see {@see ProductSearchClient::referenceImageName()} for help formatting this field. + */ + function delete_reference_image_sample(string $formattedName): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + $productSearchClient->deleteReferenceImage($formattedName); + printf('Call completed successfully.' . PHP_EOL); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::referenceImageName( + '[PROJECT]', + '[LOCATION]', + '[PRODUCT]', + '[REFERENCE_IMAGE]' + ); + + delete_reference_image_sample($formattedName); + } + ``` syntax: parameters: - @@ -386,6 +716,51 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\Product; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedName Resource name of the Product to get. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Please see {@see ProductSearchClient::productName()} for help formatting this field. + */ + function get_product_sample(string $formattedName): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var Product $response */ + $response = $productSearchClient->getProduct($formattedName); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); + + get_product_sample($formattedName); + } + ``` syntax: parameters: - @@ -419,6 +794,51 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Cloud\Vision\V1\ProductSet; + + /** + * @param string $formattedName Resource name of the ProductSet to get. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. + */ + function get_product_set_sample(string $formattedName): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var ProductSet $response */ + $response = $productSearchClient->getProductSet($formattedName); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); + + get_product_set_sample($formattedName); + } + ``` syntax: parameters: - @@ -452,6 +872,56 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Cloud\Vision\V1\ReferenceImage; + + /** + * @param string $formattedName The resource name of the ReferenceImage to get. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. Please see + * {@see ProductSearchClient::referenceImageName()} for help formatting this field. + */ + function get_reference_image_sample(string $formattedName): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var ReferenceImage $response */ + $response = $productSearchClient->getReferenceImage($formattedName); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::referenceImageName( + '[PROJECT]', + '[LOCATION]', + '[PRODUCT]', + '[REFERENCE_IMAGE]' + ); + + get_reference_image_sample($formattedName); + } + ``` syntax: parameters: - @@ -477,8 +947,8 @@ items: Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. - The google.longrunning.Operation API can be used to keep track of the - progress and results of the request. + The google.longrunning.Operation API can be + used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) @@ -491,6 +961,66 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\OperationResponse; + use Google\Cloud\Vision\V1\ImportProductSetsInputConfig; + use Google\Cloud\Vision\V1\ImportProductSetsResponse; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Rpc\Status; + + /** + * @param string $formattedParent The project in which the ProductSets should be imported. + * + * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see + * {@see ProductSearchClient::locationName()} for help formatting this field. + */ + function import_product_sets_sample(string $formattedParent): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $inputConfig = new ImportProductSetsInputConfig(); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $productSearchClient->importProductSets($formattedParent, $inputConfig); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var ImportProductSetsResponse $result */ + $result = $response->getResult(); + printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString()); + } else { + /** @var Status $error */ + $error = $response->getError(); + printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); + + import_product_sets_sample($formattedParent); + } + ``` syntax: parameters: - @@ -525,6 +1055,55 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\PagedListResponse; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Cloud\Vision\V1\ProductSet; + + /** + * @param string $formattedParent The project from which ProductSets should be listed. + * + * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see + * {@see ProductSearchClient::locationName()} for help formatting this field. + */ + function list_product_sets_sample(string $formattedParent): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $productSearchClient->listProductSets($formattedParent); + + /** @var ProductSet $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); + + list_product_sets_sample($formattedParent); + } + ``` syntax: parameters: - @@ -558,6 +1137,56 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\PagedListResponse; + use Google\Cloud\Vision\V1\Product; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedParent The project OR ProductSet from which Products should be listed. + * + * Format: + * `projects/PROJECT_ID/locations/LOC_ID` + * Please see {@see ProductSearchClient::locationName()} for help formatting this field. + */ + function list_products_sample(string $formattedParent): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $productSearchClient->listProducts($formattedParent); + + /** @var Product $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); + + list_products_sample($formattedParent); + } + ``` syntax: parameters: - @@ -594,6 +1223,56 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\PagedListResponse; + use Google\Cloud\Vision\V1\Product; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedName The ProductSet resource for which to retrieve Products. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. + */ + function list_products_in_product_set_sample(string $formattedName): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $productSearchClient->listProductsInProductSet($formattedName); + + /** @var Product $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); + + list_products_in_product_set_sample($formattedName); + } + ``` syntax: parameters: - @@ -629,6 +1308,56 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\PagedListResponse; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Cloud\Vision\V1\ReferenceImage; + + /** + * @param string $formattedParent Resource name of the product containing the reference images. + * + * Format is + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. Please see + * {@see ProductSearchClient::productName()} for help formatting this field. + */ + function list_reference_images_sample(string $formattedParent): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $productSearchClient->listReferenceImages($formattedParent); + + /** @var ReferenceImage $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); + + list_reference_images_sample($formattedParent); + } + ``` syntax: parameters: - @@ -672,8 +1401,8 @@ items: ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. - The google.longrunning.Operation API can be used to keep track of the - progress and results of the request. + The google.longrunning.Operation API can be + used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) The async variant is Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync() . @@ -681,6 +1410,59 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\ApiCore\OperationResponse; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Rpc\Status; + + /** + * @param string $formattedParent The project and location in which the Products should be deleted. + * + * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see + * {@see ProductSearchClient::locationName()} for help formatting this field. + */ + function purge_products_sample(string $formattedParent): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $productSearchClient->purgeProducts($formattedParent); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } else { + /** @var Status $error */ + $error = $response->getError(); + printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); + } + } catch (ApiException $ex) { + 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 + { + $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); + + purge_products_sample($formattedParent); + } + ``` syntax: parameters: - @@ -711,6 +1493,57 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * @param string $formattedName The resource name for the ProductSet to modify. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. + * @param string $formattedProduct The resource name for the Product to be removed from this ProductSet. + * + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Please see {@see ProductSearchClient::productName()} for help formatting this field. + */ + function remove_product_from_product_set_sample( + string $formattedName, + string $formattedProduct + ): void { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Call the API and handle any network failures. + try { + $productSearchClient->removeProductFromProductSet($formattedName, $formattedProduct); + printf('Call completed successfully.' . PHP_EOL); + } catch (ApiException $ex) { + 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 + { + $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); + $formattedProduct = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); + + remove_product_from_product_set_sample($formattedName, $formattedProduct); + } + ``` syntax: parameters: - @@ -752,6 +1585,38 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\Product; + use Google\Cloud\Vision\V1\ProductSearchClient; + + /** + * 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 update_product_sample(): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $product = new Product(); + + // Call the API and handle any network failures. + try { + /** @var Product $response */ + $response = $productSearchClient->updateProduct($product); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } + } + ``` syntax: parameters: - @@ -789,6 +1654,38 @@ items: type: method langs: - php + example: + - |- + ```php + use Google\ApiCore\ApiException; + use Google\Cloud\Vision\V1\ProductSearchClient; + use Google\Cloud\Vision\V1\ProductSet; + + /** + * 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 update_product_set_sample(): void + { + // Create a client. + $productSearchClient = new ProductSearchClient(); + + // Prepare any non-scalar elements to be passed along with the request. + $productSet = new ProductSet(); + + // Call the API and handle any network failures. + try { + /** @var ProductSet $response */ + $response = $productSearchClient->updateProductSet($productSet); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } + } + ``` syntax: parameters: - @@ -821,12 +1718,12 @@ items: var_type: 'Google\Cloud\Vision\V1\AddProductToProductSetRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<void>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductAsync()' name: createProductAsync @@ -842,12 +1739,12 @@ items: var_type: 'Google\Cloud\Vision\V1\CreateProductRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\Product>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSetAsync()' name: createProductSetAsync @@ -863,12 +1760,12 @@ items: var_type: 'Google\Cloud\Vision\V1\CreateProductSetRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\ProductSet>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImageAsync()' name: createReferenceImageAsync @@ -884,12 +1781,12 @@ items: var_type: 'Google\Cloud\Vision\V1\CreateReferenceImageRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\ReferenceImage>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductAsync()' name: deleteProductAsync @@ -905,12 +1802,12 @@ items: var_type: 'Google\Cloud\Vision\V1\DeleteProductRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<void>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSetAsync()' name: deleteProductSetAsync @@ -926,12 +1823,12 @@ items: var_type: 'Google\Cloud\Vision\V1\DeleteProductSetRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<void>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImageAsync()' name: deleteReferenceImageAsync @@ -947,12 +1844,12 @@ items: var_type: 'Google\Cloud\Vision\V1\DeleteReferenceImageRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<void>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductAsync()' name: getProductAsync @@ -968,12 +1865,12 @@ items: var_type: 'Google\Cloud\Vision\V1\GetProductRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\Product>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSetAsync()' name: getProductSetAsync @@ -989,12 +1886,12 @@ items: var_type: 'Google\Cloud\Vision\V1\GetProductSetRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\ProductSet>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImageAsync()' name: getReferenceImageAsync @@ -1010,12 +1907,12 @@ items: var_type: 'Google\Cloud\Vision\V1\GetReferenceImageRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\ReferenceImage>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSetsAsync()' name: importProductSetsAsync @@ -1031,12 +1928,12 @@ items: var_type: 'Google\Cloud\Vision\V1\ImportProductSetsRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSetsAsync()' name: listProductSetsAsync @@ -1052,12 +1949,12 @@ items: var_type: 'Google\Cloud\Vision\V1\ListProductSetsRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsAsync()' name: listProductsAsync @@ -1073,12 +1970,12 @@ items: var_type: 'Google\Cloud\Vision\V1\ListProductsRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSetAsync()' name: listProductsInProductSetAsync @@ -1094,12 +1991,12 @@ items: var_type: 'Google\Cloud\Vision\V1\ListProductsInProductSetRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImagesAsync()' name: listReferenceImagesAsync @@ -1115,12 +2012,12 @@ items: var_type: 'Google\Cloud\Vision\V1\ListReferenceImagesRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync()' name: purgeProductsAsync @@ -1136,12 +2033,12 @@ items: var_type: 'Google\Cloud\Vision\V1\PurgeProductsRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSetAsync()' name: removeProductFromProductSetAsync @@ -1157,12 +2054,12 @@ items: var_type: 'Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<void>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductAsync()' name: updateProductAsync @@ -1178,12 +2075,12 @@ items: var_type: 'Google\Cloud\Vision\V1\UpdateProductRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\Product>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSetAsync()' name: updateProductSetAsync @@ -1199,12 +2096,12 @@ items: var_type: 'Google\Cloud\Vision\V1\UpdateProductSetRequest' description: '' - - id: 'optionalArgs = []' + id: optionalArgs var_type: array description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Vision\V1\ProductSet>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getOperationsClient()' name: getOperationsClient diff --git a/dev/tests/fixtures/docfx/Vision/V1.CreateReferenceImageRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.CreateReferenceImageRequest.yml index c79cd34fcbb7..ffe7028e2386 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.CreateReferenceImageRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.CreateReferenceImageRequest.yml @@ -56,7 +56,8 @@ items: name: getParent id: getParent summary: |- - Required. Resource name of the product in which to create the reference image. + Required. Resource name of the product in which to create the reference + image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @@ -73,7 +74,8 @@ items: name: setParent id: setParent summary: |- - Required. Resource name of the product in which to create the reference image. + Required. Resource name of the product in which to create the reference + image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @@ -196,7 +198,8 @@ items: id: parent var_type: string description: |- - Required. Resource name of the product in which to create the reference image. + Required. Resource name of the product in which to create the reference + image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. Please see diff --git a/dev/tests/fixtures/docfx/Vision/V1.GcsDestination.yml b/dev/tests/fixtures/docfx/Vision/V1.GcsDestination.yml index 50e18e610e41..b03d1f9f5daa 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.GcsDestination.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.GcsDestination.yml @@ -35,7 +35,7 @@ items: - id: '↳ uri' var_type: string - description: 'Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.' + description: 'Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.' - uid: '\Google\Cloud\Vision\V1\GcsDestination::getUri()' name: getUri diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml b/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml index 5a7f06400099..a11aef01269b 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml @@ -9,51 +9,6 @@ items: Service Description: Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images. - - This class provides the ability to make remote calls to the backing service through method - calls that map to API methods. Sample code to get started: - - ```php - $imageAnnotatorClient = new ImageAnnotatorClient(); - try { - $requests = []; - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $imageAnnotatorClient->resumeOperation($operationName, 'asyncBatchAnnotateFiles'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } - } finally { - $imageAnnotatorClient->close(); - } - ``` - - Many parameters require resource names to be formatted in a particular way. To - assist with these names, this class includes a format method for each type of - name, and additionally a parseName method to extract the individual identifiers - contained within formatted names that are returned by the API. - - This service has a new (beta) implementation. See Google\Cloud\Vision\V1\Client\ImageAnnotatorClient to use the new surface. type: class namespace: 'Google \ Cloud \ Vision \ V1' langs: @@ -73,19 +28,6 @@ items: - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::webDetection()' - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::objectLocalization()' - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::productSearch()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::__construct()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::asyncBatchAnnotateFiles()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::asyncBatchAnnotateImages()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::batchAnnotateFiles()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::batchAnnotateImages()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::getOperationsClient()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::resumeOperation()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::productSetName()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::parseName()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::SERVICE_NAME' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::SERVICE_ADDRESS' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::DEFAULT_SERVICE_PORT' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::CODEGEN_NAME' - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::createImageObject()' name: createImageObject @@ -633,509 +575,3 @@ items: returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::__construct()' - name: __construct - id: __construct - summary: Constructor. - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: options - var_type: array - description: 'Optional. Options for configuring the service API wrapper.' - - - id: '↳ apiEndpoint' - var_type: string - description: 'The address of the API remote host. May optionally include the port, formatted as ":". Default ''vision.googleapis.com:443''.' - - - id: '↳ credentials' - var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' - - - id: '↳ credentialsConfig' - var_type: array - description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' - - - id: '↳ disableRetries' - var_type: bool - description: 'Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.' - - - id: '↳ clientConfig' - var_type: string|array - description: 'Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.' - - - id: '↳ transport' - var_type: string|TransportInterface - description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' - - - id: '↳ transportConfig' - var_type: array - description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' - - - id: '↳ clientCertSource' - var_type: callable - description: 'A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::asyncBatchAnnotateFiles()' - name: asyncBatchAnnotateFiles - id: asyncBatchAnnotateFiles - summary: |+ - Run asynchronous image detection and annotation for a list of generic - files, such as PDF files, which may contain multiple pages and multiple - images per page. Progress and results can be retrieved through the - `google.longrunning.Operations` interface. - - `Operation.metadata` contains `OperationMetadata` (metadata). - `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). - - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\OperationResponse; - use Google\Cloud\Vision\V1\AsyncAnnotateFileRequest; - use Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse; - use Google\Cloud\Vision\V1\ImageAnnotatorClient; - use Google\Rpc\Status; - - /** - * 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 async_batch_annotate_files_sample(): void - { - // Create a client. - $imageAnnotatorClient = new ImageAnnotatorClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $requests = [new AsyncAnnotateFileRequest()]; - - // Call the API and handle any network failures. - try { - /** @var OperationResponse $response */ - $response = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $response->pollUntilComplete(); - - if ($response->operationSucceeded()) { - /** @var AsyncBatchAnnotateFilesResponse $result */ - $result = $response->getResult(); - printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString()); - } else { - /** @var Status $error */ - $error = $response->getError(); - printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); - } - } catch (ApiException $ex) { - printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); - } - } - ``` - syntax: - parameters: - - - id: requests - var_type: 'array<Google\Cloud\Vision\V1\AsyncAnnotateFileRequest>' - description: 'Required. Individual async file annotation requests for this batch.' - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ parent' - var_type: string - description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\OperationResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::asyncBatchAnnotateImages()' - name: asyncBatchAnnotateImages - id: asyncBatchAnnotateImages - summary: |+ - Run asynchronous image detection and annotation for a list of images. - - Progress and results can be retrieved through the - `google.longrunning.Operations` interface. - `Operation.metadata` contains `OperationMetadata` (metadata). - `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - - This service will write image annotation outputs to json files in customer - GCS bucket, each json file containing BatchAnnotateImagesResponse proto. - - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\OperationResponse; - use Google\Cloud\Vision\V1\AnnotateImageRequest; - use Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse; - use Google\Cloud\Vision\V1\ImageAnnotatorClient; - use Google\Cloud\Vision\V1\OutputConfig; - use Google\Rpc\Status; - - /** - * 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 async_batch_annotate_images_sample(): void - { - // Create a client. - $imageAnnotatorClient = new ImageAnnotatorClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $requests = [new AnnotateImageRequest()]; - $outputConfig = new OutputConfig(); - - // Call the API and handle any network failures. - try { - /** @var OperationResponse $response */ - $response = $imageAnnotatorClient->asyncBatchAnnotateImages($requests, $outputConfig); - $response->pollUntilComplete(); - - if ($response->operationSucceeded()) { - /** @var AsyncBatchAnnotateImagesResponse $result */ - $result = $response->getResult(); - printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString()); - } else { - /** @var Status $error */ - $error = $response->getError(); - printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); - } - } catch (ApiException $ex) { - printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); - } - } - ``` - syntax: - parameters: - - - id: requests - var_type: 'array<Google\Cloud\Vision\V1\AnnotateImageRequest>' - description: 'Required. Individual image annotation requests for this batch.' - - - id: outputConfig - var_type: 'Google\Cloud\Vision\V1\OutputConfig' - description: 'Required. The desired output location and metadata (e.g. format).' - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ parent' - var_type: string - description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\OperationResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::batchAnnotateFiles()' - name: batchAnnotateFiles - id: batchAnnotateFiles - summary: |+ - Service that performs image detection and annotation for a batch of files. - - Now only "application/pdf", "image/tiff" and "image/gif" are supported. - - This service will extract at most 5 (customers can specify which 5 in - AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - file provided and perform detection and annotation for each image - extracted. - - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\AnnotateFileRequest; - use Google\Cloud\Vision\V1\BatchAnnotateFilesResponse; - use Google\Cloud\Vision\V1\ImageAnnotatorClient; - - /** - * 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 batch_annotate_files_sample(): void - { - // Create a client. - $imageAnnotatorClient = new ImageAnnotatorClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $requests = [new AnnotateFileRequest()]; - - // Call the API and handle any network failures. - try { - /** @var BatchAnnotateFilesResponse $response */ - $response = $imageAnnotatorClient->batchAnnotateFiles($requests); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); - } - } - ``` - syntax: - parameters: - - - id: requests - var_type: 'array<Google\Cloud\Vision\V1\AnnotateFileRequest>' - description: |- - Required. The list of file annotation requests. Right now we support only one - AnnotateFileRequest in BatchAnnotateFilesRequest. - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ parent' - var_type: string - description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\BatchAnnotateFilesResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::batchAnnotateImages()' - name: batchAnnotateImages - id: batchAnnotateImages - summary: |+ - Run image detection and annotation for a batch of images. - - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\AnnotateImageRequest; - use Google\Cloud\Vision\V1\BatchAnnotateImagesResponse; - use Google\Cloud\Vision\V1\ImageAnnotatorClient; - - /** - * 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 batch_annotate_images_sample(): void - { - // Create a client. - $imageAnnotatorClient = new ImageAnnotatorClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $requests = [new AnnotateImageRequest()]; - - // Call the API and handle any network failures. - try { - /** @var BatchAnnotateImagesResponse $response */ - $response = $imageAnnotatorClient->batchAnnotateImages($requests); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); - } - } - ``` - syntax: - parameters: - - - id: requests - var_type: 'array<Google\Cloud\Vision\V1\AnnotateImageRequest>' - description: 'Required. Individual image annotation requests for this batch.' - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ parent' - var_type: string - description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\BatchAnnotateImagesResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::getOperationsClient()' - name: getOperationsClient - id: getOperationsClient - summary: 'Return an OperationsClient object with the same endpoint as $this.' - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - returns: - - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::resumeOperation()' - name: resumeOperation - id: resumeOperation - summary: |- - Resume an existing long running operation that was previously started by a long - running API method. If $methodName is not provided, or does not match a long - running API method, then the operation can still be resumed, but the - OperationResponse object will not deserialize the final response. - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: operationName - var_type: string - description: 'The name of the long running operation' - - - id: methodName - var_type: string - description: 'The name of the method used to start the operation' - returns: - - - var_type: 'Google\ApiCore\OperationResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::productSetName()' - name: 'static::productSetName' - id: productSetName - summary: |- - Formats a string containing the fully-qualified path to represent a product_set - resource. - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: project - var_type: string - description: '' - - - id: location - var_type: string - description: '' - - - id: productSet - var_type: string - description: '' - returns: - - - var_type: string - description: 'The formatted product_set resource.' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::parseName()' - name: 'static::parseName' - id: parseName - summary: |- - Parses a formatted name string and returns an associative array of the components in the name. - - The following name formats are supported: - Template: Pattern - - productSet: projects/{project}/locations/{location}/productSets/{product_set} - - The optional $template argument can be supplied to specify a particular pattern, - and must match one of the templates listed above. If no $template argument is - provided, or if the $template argument does not match one of the templates - listed, then parseName will check each of the supported templates, and return - the first match. - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: formattedName - var_type: string - description: 'The formatted name string' - - - id: template - var_type: string - description: 'Optional name of template to match' - returns: - - - var_type: array - description: 'An associative array from name component IDs to component values.' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::SERVICE_NAME' - name: SERVICE_NAME - id: SERVICE_NAME - summary: 'The name of the service.' - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: const - langs: - - php - syntax: - content: "Value: 'google.cloud.vision.v1.ImageAnnotator'" - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::SERVICE_ADDRESS' - name: SERVICE_ADDRESS - id: SERVICE_ADDRESS - summary: 'The default address of the service.' - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: const - langs: - - php - syntax: - content: "Value: 'vision.googleapis.com'" - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::DEFAULT_SERVICE_PORT' - name: DEFAULT_SERVICE_PORT - id: DEFAULT_SERVICE_PORT - summary: 'The default port of the service.' - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: const - langs: - - php - syntax: - content: 'Value: 443' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::CODEGEN_NAME' - name: CODEGEN_NAME - id: CODEGEN_NAME - summary: 'The name of the code generator, to be included in the agent header.' - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: const - langs: - - php - syntax: - content: "Value: 'gapic'" diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsGcsSource.yml b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsGcsSource.yml index 4f8e6d3776b5..101f3a967fb5 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsGcsSource.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsGcsSource.yml @@ -63,13 +63,15 @@ items: `product-display-name` column refers to display_name, the `product-category` column refers to - product_category, and the - `labels` column refers to product_labels. + product_category, and + the `labels` column refers to + product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system - sets the display_name field for the product to a - space (" "). You can update the `display_name` later by using the API. + sets the display_name field + for the product to a space (" "). You can update the `display_name` later + by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. @@ -124,13 +126,15 @@ items: `product-display-name` column refers to display_name, the `product-category` column refers to - product_category, and the - `labels` column refers to product_labels. + product_category, and + the `labels` column refers to + product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system - sets the display_name field for the product to a - space (" "). You can update the `display_name` later by using the API. + sets the display_name field + for the product to a space (" "). You can update the `display_name` later + by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml index 00eb0cf33d7a..24487b04acea 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml @@ -9,8 +9,10 @@ items: Response message for the `ImportProductSets` method. This message is returned by the - google.longrunning.Operations.GetOperation method in the returned - google.longrunning.Operation.response field. + google.longrunning.Operations.GetOperation + method in the returned + google.longrunning.Operation.response + field. Generated from protobuf message google.cloud.vision.v1.ImportProductSetsResponse type: class diff --git a/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml b/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml index d0ee6b06219c..7ff1dc4c6297 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml @@ -49,7 +49,7 @@ items: - id: '↳ bounding_box' var_type: 'Google\Cloud\Vision\V1\BoundingPoly' - description: "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." + description: "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * * when the text is horizontal it might look like: 0----1 | | 3----2 * * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." - id: '↳ words' var_type: 'array<Google\Cloud\Vision\V1\Word>' diff --git a/dev/tests/fixtures/docfx/Vision/V1.Product.yml b/dev/tests/fixtures/docfx/Vision/V1.Product.yml index 8dd81fa31000..b76715c79603 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Product.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Product.yml @@ -176,10 +176,12 @@ items: name: getProductCategory id: getProductCategory summary: |- - Immutable. The category for the product identified by the reference image. This should - be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or - "general-v1". The legacy categories "homegoods", "apparel", and "toys" are - still supported, but these should not be used for new products. + Immutable. The category for the product identified by the reference image. + + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", + "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", + "apparel", and "toys" are still supported, but these should not be used for + new products. parent: \Google\Cloud\Vision\V1\Product type: method langs: @@ -193,10 +195,12 @@ items: name: setProductCategory id: setProductCategory summary: |- - Immutable. The category for the product identified by the reference image. This should - be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or - "general-v1". The legacy categories "homegoods", "apparel", and "toys" are - still supported, but these should not be used for new products. + Immutable. The category for the product identified by the reference image. + + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", + "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", + "apparel", and "toys" are still supported, but these should not be used for + new products. parent: \Google\Cloud\Vision\V1\Product type: method langs: diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml index d20baa7dab5d..27869fba91bc 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml @@ -8,2073 +8,7 @@ items: summary: |- Service Description: Manages Products and ProductSets of reference images for use in product search. It uses the following resource model: - - - The API has a collection of ProductSet resources, named - `projects/*/locations/*/productSets/*`, which acts as a way to put different - products into groups to limit identification. - - In parallel, - - - The API has a collection of Product resources, named - `projects/*/locations/*/products/*` - - - Each Product has a collection of ReferenceImage resources, named - `projects/*/locations/*/products/*/referenceImages/*` - - This class provides the ability to make remote calls to the backing service through method - calls that map to API methods. Sample code to get started: - - ```php - $productSearchClient = new ProductSearchClient(); - try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->addProductToProductSet($formattedName, $formattedProduct); - } finally { - $productSearchClient->close(); - } - ``` - - Many parameters require resource names to be formatted in a particular way. To - assist with these names, this class includes a format method for each type of - name, and additionally a parseName method to extract the individual identifiers - contained within formatted names that are returned by the API. - - This service has a new (beta) implementation. See Google\Cloud\Vision\V1\Client\ProductSearchClient to use the new surface. type: class namespace: 'Google \ Cloud \ Vision \ V1' langs: - php - children: - - '\Google\Cloud\Vision\V1\ProductSearchClient::__construct()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::addProductToProductSet()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::createProduct()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::createProductSet()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::createReferenceImage()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::deleteProduct()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::deleteProductSet()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::deleteReferenceImage()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::getProduct()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::getProductSet()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::getReferenceImage()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::importProductSets()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::listProductSets()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::listProducts()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::listProductsInProductSet()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::listReferenceImages()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::purgeProducts()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::removeProductFromProductSet()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::updateProduct()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::updateProductSet()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::getOperationsClient()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::resumeOperation()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::locationName()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::productName()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::productSetName()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::referenceImageName()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::parseName()' - - '\Google\Cloud\Vision\V1\ProductSearchClient::SERVICE_NAME' - - '\Google\Cloud\Vision\V1\ProductSearchClient::SERVICE_ADDRESS' - - '\Google\Cloud\Vision\V1\ProductSearchClient::DEFAULT_SERVICE_PORT' - - '\Google\Cloud\Vision\V1\ProductSearchClient::CODEGEN_NAME' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::__construct()' - name: __construct - id: __construct - summary: Constructor. - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - parameters: - - - id: options - var_type: array - description: 'Optional. Options for configuring the service API wrapper.' - - - id: '↳ apiEndpoint' - var_type: string - description: 'The address of the API remote host. May optionally include the port, formatted as ":". Default ''vision.googleapis.com:443''.' - - - id: '↳ credentials' - var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' - - - id: '↳ credentialsConfig' - var_type: array - description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' - - - id: '↳ disableRetries' - var_type: bool - description: 'Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.' - - - id: '↳ clientConfig' - var_type: string|array - description: 'Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.' - - - id: '↳ transport' - var_type: string|TransportInterface - description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' - - - id: '↳ transportConfig' - var_type: array - description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' - - - id: '↳ clientCertSource' - var_type: callable - description: 'A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::addProductToProductSet()' - name: addProductToProductSet - id: addProductToProductSet - summary: |+ - Adds a Product to the specified ProductSet. If the Product is already - present, no change is made. - - One Product can be added to at most 100 ProductSets. - - Possible errors: - - * Returns NOT_FOUND if the Product or the ProductSet doesn't exist. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedName The resource name for the ProductSet to modify. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. - * @param string $formattedProduct The resource name for the Product to be added to this ProductSet. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - * Please see {@see ProductSearchClient::productName()} for help formatting this field. - */ - function add_product_to_product_set_sample(string $formattedName, string $formattedProduct): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - $productSearchClient->addProductToProductSet($formattedName, $formattedProduct); - printf('Call completed successfully.' . PHP_EOL); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - - add_product_to_product_set_sample($formattedName, $formattedProduct); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. The resource name for the ProductSet to modify. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - - id: product - var_type: string - description: |- - Required. The resource name for the Product to be added to this ProductSet. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::createProduct()' - name: createProduct - id: createProduct - summary: |+ - Creates and returns a new product resource. - - Possible errors: - - * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 - characters. - * Returns INVALID_ARGUMENT if description is longer than 4096 characters. - * Returns INVALID_ARGUMENT if product_category is missing or invalid. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\Product; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedParent The project in which the Product should be created. - * - * Format is - * `projects/PROJECT_ID/locations/LOC_ID`. Please see - * {@see ProductSearchClient::locationName()} for help formatting this field. - */ - function create_product_sample(string $formattedParent): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $product = new Product(); - - // Call the API and handle any network failures. - try { - /** @var Product $response */ - $response = $productSearchClient->createProduct($formattedParent, $product); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); - - create_product_sample($formattedParent); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. The project in which the Product should be created. - - Format is - `projects/PROJECT_ID/locations/LOC_ID`. - - - id: product - var_type: 'Google\Cloud\Vision\V1\Product' - description: 'Required. The product to create.' - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ productId' - var_type: string - description: 'A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\Product' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::createProductSet()' - name: createProductSet - id: createProductSet - summary: |+ - Creates and returns a new ProductSet resource. - - Possible errors: - - * Returns INVALID_ARGUMENT if display_name is missing, or is longer than - 4096 characters. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ProductSet; - - /** - * @param string $formattedParent The project in which the ProductSet should be created. - * - * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see - * {@see ProductSearchClient::locationName()} for help formatting this field. - */ - function create_product_set_sample(string $formattedParent): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $productSet = new ProductSet(); - - // Call the API and handle any network failures. - try { - /** @var ProductSet $response */ - $response = $productSearchClient->createProductSet($formattedParent, $productSet); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); - - create_product_set_sample($formattedParent); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. The project in which the ProductSet should be created. - - Format is `projects/PROJECT_ID/locations/LOC_ID`. - - - id: productSet - var_type: 'Google\Cloud\Vision\V1\ProductSet' - description: 'Required. The ProductSet to create.' - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ productSetId' - var_type: string - description: 'A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\ProductSet' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::createReferenceImage()' - name: createReferenceImage - id: createReferenceImage - summary: |+ - Creates and returns a new ReferenceImage resource. - - The `bounding_poly` field is optional. If `bounding_poly` is not specified, - the system will try to detect regions of interest in the image that are - compatible with the product_category on the parent product. If it is - specified, detection is ALWAYS skipped. The system converts polygons into - non-rotated rectangles. - - Note that the pipeline will resize the image if the image resolution is too - large to process (above 50MP). - - Possible errors: - - * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 - characters. - * Returns INVALID_ARGUMENT if the product does not exist. - * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing - compatible with the parent product's product_category is detected. - * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ReferenceImage; - - /** - * @param string $formattedParent Resource name of the product in which to create the reference image. - * - * Format is - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. Please see - * {@see ProductSearchClient::productName()} for help formatting this field. - * @param string $referenceImageUri The Google Cloud Storage URI of the reference image. - * - * The URI must start with `gs://`. - */ - function create_reference_image_sample(string $formattedParent, string $referenceImageUri): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $referenceImage = (new ReferenceImage()) - ->setUri($referenceImageUri); - - // Call the API and handle any network failures. - try { - /** @var ReferenceImage $response */ - $response = $productSearchClient->createReferenceImage($formattedParent, $referenceImage); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $referenceImageUri = '[URI]'; - - create_reference_image_sample($formattedParent, $referenceImageUri); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. Resource name of the product in which to create the reference image. - - Format is - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - - - id: referenceImage - var_type: 'Google\Cloud\Vision\V1\ReferenceImage' - description: |- - Required. The reference image to create. - If an image ID is specified, it is ignored. - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ referenceImageId' - var_type: string - description: 'A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\ReferenceImage' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::deleteProduct()' - name: deleteProduct - id: deleteProduct - summary: |+ - Permanently deletes a product and its reference images. - - Metadata of the product and all its images will be deleted right away, but - search queries against ProductSets containing the product may still work - until all related caches are refreshed. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedName Resource name of product to delete. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - * Please see {@see ProductSearchClient::productName()} for help formatting this field. - */ - function delete_product_sample(string $formattedName): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - $productSearchClient->deleteProduct($formattedName); - printf('Call completed successfully.' . PHP_EOL); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - - delete_product_sample($formattedName); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. Resource name of product to delete. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::deleteProductSet()' - name: deleteProductSet - id: deleteProductSet - summary: |+ - Permanently deletes a ProductSet. Products and ReferenceImages in the - ProductSet are not deleted. - - The actual image files are not deleted from Google Cloud Storage. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedName Resource name of the ProductSet to delete. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. - */ - function delete_product_set_sample(string $formattedName): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - $productSearchClient->deleteProductSet($formattedName); - printf('Call completed successfully.' . PHP_EOL); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - - delete_product_set_sample($formattedName); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. Resource name of the ProductSet to delete. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::deleteReferenceImage()' - name: deleteReferenceImage - id: deleteReferenceImage - summary: |+ - Permanently deletes a reference image. - - The image metadata will be deleted right away, but search queries - against ProductSets containing the image may still work until all related - caches are refreshed. - - The actual image files are not deleted from Google Cloud Storage. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedName The resource name of the reference image to delete. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` - * Please see {@see ProductSearchClient::referenceImageName()} for help formatting this field. - */ - function delete_reference_image_sample(string $formattedName): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - $productSearchClient->deleteReferenceImage($formattedName); - printf('Call completed successfully.' . PHP_EOL); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::referenceImageName( - '[PROJECT]', - '[LOCATION]', - '[PRODUCT]', - '[REFERENCE_IMAGE]' - ); - - delete_reference_image_sample($formattedName); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. The resource name of the reference image to delete. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::getProduct()' - name: getProduct - id: getProduct - summary: |+ - Gets information associated with a Product. - - Possible errors: - - * Returns NOT_FOUND if the Product does not exist. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\Product; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedName Resource name of the Product to get. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - * Please see {@see ProductSearchClient::productName()} for help formatting this field. - */ - function get_product_sample(string $formattedName): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var Product $response */ - $response = $productSearchClient->getProduct($formattedName); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - - get_product_sample($formattedName); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. Resource name of the Product to get. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\Product' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::getProductSet()' - name: getProductSet - id: getProductSet - summary: |+ - Gets information associated with a ProductSet. - - Possible errors: - - * Returns NOT_FOUND if the ProductSet does not exist. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ProductSet; - - /** - * @param string $formattedName Resource name of the ProductSet to get. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. - */ - function get_product_set_sample(string $formattedName): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var ProductSet $response */ - $response = $productSearchClient->getProductSet($formattedName); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - - get_product_set_sample($formattedName); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. Resource name of the ProductSet to get. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\ProductSet' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::getReferenceImage()' - name: getReferenceImage - id: getReferenceImage - summary: |+ - Gets information associated with a ReferenceImage. - - Possible errors: - - * Returns NOT_FOUND if the specified image does not exist. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ReferenceImage; - - /** - * @param string $formattedName The resource name of the ReferenceImage to get. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. Please see - * {@see ProductSearchClient::referenceImageName()} for help formatting this field. - */ - function get_reference_image_sample(string $formattedName): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var ReferenceImage $response */ - $response = $productSearchClient->getReferenceImage($formattedName); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::referenceImageName( - '[PROJECT]', - '[LOCATION]', - '[PRODUCT]', - '[REFERENCE_IMAGE]' - ); - - get_reference_image_sample($formattedName); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. The resource name of the ReferenceImage to get. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\ReferenceImage' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::importProductSets()' - name: importProductSets - id: importProductSets - summary: |+ - Asynchronous API that imports a list of reference images to specified - product sets based on a list of image information. - - The google.longrunning.Operation API can be used to keep track of the - progress and results of the request. - `Operation.metadata` contains `BatchOperationMetadata`. (progress) - `Operation.response` contains `ImportProductSetsResponse`. (results) - - The input source of this method is a csv file on Google Cloud Storage. - For the format of the csv file please see - ImportProductSetsGcsSource.csv_file_uri. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\OperationResponse; - use Google\Cloud\Vision\V1\ImportProductSetsInputConfig; - use Google\Cloud\Vision\V1\ImportProductSetsResponse; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Rpc\Status; - - /** - * @param string $formattedParent The project in which the ProductSets should be imported. - * - * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see - * {@see ProductSearchClient::locationName()} for help formatting this field. - */ - function import_product_sets_sample(string $formattedParent): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $inputConfig = new ImportProductSetsInputConfig(); - - // Call the API and handle any network failures. - try { - /** @var OperationResponse $response */ - $response = $productSearchClient->importProductSets($formattedParent, $inputConfig); - $response->pollUntilComplete(); - - if ($response->operationSucceeded()) { - /** @var ImportProductSetsResponse $result */ - $result = $response->getResult(); - printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString()); - } else { - /** @var Status $error */ - $error = $response->getError(); - printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); - } - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); - - import_product_sets_sample($formattedParent); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. The project in which the ProductSets should be imported. - - Format is `projects/PROJECT_ID/locations/LOC_ID`. - - - id: inputConfig - var_type: 'Google\Cloud\Vision\V1\ImportProductSetsInputConfig' - description: 'Required. The input content for the list of requests.' - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\OperationResponse' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listProductSets()' - name: listProductSets - id: listProductSets - summary: |+ - Lists ProductSets in an unspecified order. - - Possible errors: - - * Returns INVALID_ARGUMENT if page_size is greater than 100, or less - than 1. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\PagedListResponse; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ProductSet; - - /** - * @param string $formattedParent The project from which ProductSets should be listed. - * - * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see - * {@see ProductSearchClient::locationName()} for help formatting this field. - */ - function list_product_sets_sample(string $formattedParent): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var PagedListResponse $response */ - $response = $productSearchClient->listProductSets($formattedParent); - - /** @var ProductSet $element */ - foreach ($response as $element) { - printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); - } - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); - - list_product_sets_sample($formattedParent); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. The project from which ProductSets should be listed. - - Format is `projects/PROJECT_ID/locations/LOC_ID`. - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ pageSize' - var_type: int - description: 'The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.' - - - id: '↳ pageToken' - var_type: string - description: 'A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\PagedListResponse' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listProducts()' - name: listProducts - id: listProducts - summary: |+ - Lists products in an unspecified order. - - Possible errors: - - * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\PagedListResponse; - use Google\Cloud\Vision\V1\Product; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedParent The project OR ProductSet from which Products should be listed. - * - * Format: - * `projects/PROJECT_ID/locations/LOC_ID` - * Please see {@see ProductSearchClient::locationName()} for help formatting this field. - */ - function list_products_sample(string $formattedParent): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var PagedListResponse $response */ - $response = $productSearchClient->listProducts($formattedParent); - - /** @var Product $element */ - foreach ($response as $element) { - printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); - } - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); - - list_products_sample($formattedParent); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. The project OR ProductSet from which Products should be listed. - - Format: - `projects/PROJECT_ID/locations/LOC_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ pageSize' - var_type: int - description: 'The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.' - - - id: '↳ pageToken' - var_type: string - description: 'A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\PagedListResponse' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listProductsInProductSet()' - name: listProductsInProductSet - id: listProductsInProductSet - summary: |+ - Lists the Products in a ProductSet, in an unspecified order. If the - ProductSet does not exist, the products field of the response will be - empty. - - Possible errors: - - * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\PagedListResponse; - use Google\Cloud\Vision\V1\Product; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedName The ProductSet resource for which to retrieve Products. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. - */ - function list_products_in_product_set_sample(string $formattedName): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var PagedListResponse $response */ - $response = $productSearchClient->listProductsInProductSet($formattedName); - - /** @var Product $element */ - foreach ($response as $element) { - printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); - } - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - - list_products_in_product_set_sample($formattedName); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. The ProductSet resource for which to retrieve Products. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ pageSize' - var_type: int - description: 'The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.' - - - id: '↳ pageToken' - var_type: string - description: 'A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\PagedListResponse' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listReferenceImages()' - name: listReferenceImages - id: listReferenceImages - summary: |+ - Lists reference images. - - Possible errors: - - * Returns NOT_FOUND if the parent product does not exist. - * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less - than 1. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\PagedListResponse; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ReferenceImage; - - /** - * @param string $formattedParent Resource name of the product containing the reference images. - * - * Format is - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. Please see - * {@see ProductSearchClient::productName()} for help formatting this field. - */ - function list_reference_images_sample(string $formattedParent): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var PagedListResponse $response */ - $response = $productSearchClient->listReferenceImages($formattedParent); - - /** @var ReferenceImage $element */ - foreach ($response as $element) { - printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); - } - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - - list_reference_images_sample($formattedParent); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. Resource name of the product containing the reference images. - - Format is - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ pageSize' - var_type: int - description: 'The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.' - - - id: '↳ pageToken' - var_type: string - description: 'A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\PagedListResponse' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::purgeProducts()' - name: purgeProducts - id: purgeProducts - summary: |+ - Asynchronous API to delete all Products in a ProductSet or all Products - that are in no ProductSet. - - If a Product is a member of the specified ProductSet in addition to other - ProductSets, the Product will still be deleted. - - It is recommended to not delete the specified ProductSet until after this - operation has completed. It is also recommended to not add any of the - Products involved in the batch delete to a new ProductSet while this - operation is running because those Products may still end up deleted. - - It's not possible to undo the PurgeProducts operation. Therefore, it is - recommended to keep the csv files used in ImportProductSets (if that was - how you originally built the Product Set) before starting PurgeProducts, in - case you need to re-import the data after deletion. - - If the plan is to purge all of the Products from a ProductSet and then - re-use the empty ProductSet to re-import new Products into the empty - ProductSet, you must wait until the PurgeProducts operation has finished - for that ProductSet. - - The google.longrunning.Operation API can be used to keep track of the - progress and results of the request. - `Operation.metadata` contains `BatchOperationMetadata`. (progress) - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\ApiCore\OperationResponse; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Rpc\Status; - - /** - * @param string $formattedParent The project and location in which the Products should be deleted. - * - * Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see - * {@see ProductSearchClient::locationName()} for help formatting this field. - */ - function purge_products_sample(string $formattedParent): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - /** @var OperationResponse $response */ - $response = $productSearchClient->purgeProducts($formattedParent); - $response->pollUntilComplete(); - - if ($response->operationSucceeded()) { - printf('Operation completed successfully.' . PHP_EOL); - } else { - /** @var Status $error */ - $error = $response->getError(); - printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); - } - } catch (ApiException $ex) { - 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 - { - $formattedParent = ProductSearchClient::locationName('[PROJECT]', '[LOCATION]'); - - purge_products_sample($formattedParent); - } - ``` - syntax: - parameters: - - - id: parent - var_type: string - description: |- - Required. The project and location in which the Products should be deleted. - - Format is `projects/PROJECT_ID/locations/LOC_ID`. - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ productSetPurgeConfig' - var_type: ProductSetPurgeConfig - description: 'Specify which ProductSet contains the Products to be deleted.' - - - id: '↳ deleteOrphanProducts' - var_type: bool - description: 'If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.' - - - id: '↳ force' - var_type: bool - description: 'The default value is false. Override this value to true to actually perform the purge.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\ApiCore\OperationResponse' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::removeProductFromProductSet()' - name: removeProductFromProductSet - id: removeProductFromProductSet - summary: |+ - Removes a Product from the specified ProductSet. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * @param string $formattedName The resource name for the ProductSet to modify. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - * Please see {@see ProductSearchClient::productSetName()} for help formatting this field. - * @param string $formattedProduct The resource name for the Product to be removed from this ProductSet. - * - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - * Please see {@see ProductSearchClient::productName()} for help formatting this field. - */ - function remove_product_from_product_set_sample( - string $formattedName, - string $formattedProduct - ): void { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Call the API and handle any network failures. - try { - $productSearchClient->removeProductFromProductSet($formattedName, $formattedProduct); - printf('Call completed successfully.' . PHP_EOL); - } catch (ApiException $ex) { - 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 - { - $formattedName = ProductSearchClient::productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = ProductSearchClient::productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - - remove_product_from_product_set_sample($formattedName, $formattedProduct); - } - ``` - syntax: - parameters: - - - id: name - var_type: string - description: |- - Required. The resource name for the ProductSet to modify. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - - id: product - var_type: string - description: |- - Required. The resource name for the Product to be removed from this ProductSet. - - Format is: - `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::updateProduct()' - name: updateProduct - id: updateProduct - summary: |+ - Makes changes to a Product resource. - - Only the `display_name`, `description`, and `labels` fields can be updated - right now. - - If labels are updated, the change will not be reflected in queries until - the next index time. - - Possible errors: - - * Returns NOT_FOUND if the Product does not exist. - * Returns INVALID_ARGUMENT if display_name is present in update_mask but is - missing from the request or longer than 4096 characters. - * Returns INVALID_ARGUMENT if description is present in update_mask but is - longer than 4096 characters. - * Returns INVALID_ARGUMENT if product_category is present in update_mask. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\Product; - use Google\Cloud\Vision\V1\ProductSearchClient; - - /** - * 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 update_product_sample(): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $product = new Product(); - - // Call the API and handle any network failures. - try { - /** @var Product $response */ - $response = $productSearchClient->updateProduct($product); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); - } - } - ``` - syntax: - parameters: - - - id: product - var_type: 'Google\Cloud\Vision\V1\Product' - description: |- - Required. The Product resource which replaces the one on the server. - product.name is immutable. - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ updateMask' - var_type: FieldMask - description: 'The FieldMask that specifies which fields to update. If update_mask isn''t specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\Product' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::updateProductSet()' - name: updateProductSet - id: updateProductSet - summary: |+ - Makes changes to a ProductSet resource. - - Only display_name can be updated currently. - - Possible errors: - - * Returns NOT_FOUND if the ProductSet does not exist. - * Returns INVALID_ARGUMENT if display_name is present in update_mask but - missing from the request or longer than 4096 characters. - - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - example: - - |- - ```php - use Google\ApiCore\ApiException; - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ProductSet; - - /** - * 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 update_product_set_sample(): void - { - // Create a client. - $productSearchClient = new ProductSearchClient(); - - // Prepare any non-scalar elements to be passed along with the request. - $productSet = new ProductSet(); - - // Call the API and handle any network failures. - try { - /** @var ProductSet $response */ - $response = $productSearchClient->updateProductSet($productSet); - printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); - } catch (ApiException $ex) { - printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); - } - } - ``` - syntax: - parameters: - - - id: productSet - var_type: 'Google\Cloud\Vision\V1\ProductSet' - description: 'Required. The ProductSet resource which replaces the one on the server.' - - - id: optionalArgs - var_type: array - description: Optional. - - - id: '↳ updateMask' - var_type: FieldMask - description: 'The FieldMask that specifies which fields to update. If update_mask isn''t specified, all mutable fields are to be updated. Valid mask path is `display_name`.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - returns: - - - var_type: 'Google\Cloud\Vision\V1\ProductSet' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::getOperationsClient()' - name: getOperationsClient - id: getOperationsClient - summary: 'Return an OperationsClient object with the same endpoint as $this.' - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - returns: - - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::resumeOperation()' - name: resumeOperation - id: resumeOperation - summary: |- - Resume an existing long running operation that was previously started by a long - running API method. If $methodName is not provided, or does not match a long - running API method, then the operation can still be resumed, but the - OperationResponse object will not deserialize the final response. - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - parameters: - - - id: operationName - var_type: string - description: 'The name of the long running operation' - - - id: methodName - var_type: string - description: 'The name of the method used to start the operation' - returns: - - - var_type: 'Google\ApiCore\OperationResponse' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::locationName()' - name: 'static::locationName' - id: locationName - summary: |- - Formats a string containing the fully-qualified path to represent a location - resource. - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - parameters: - - - id: project - var_type: string - description: '' - - - id: location - var_type: string - description: '' - returns: - - - var_type: string - description: 'The formatted location resource.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::productName()' - name: 'static::productName' - id: productName - summary: |- - Formats a string containing the fully-qualified path to represent a product - resource. - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - parameters: - - - id: project - var_type: string - description: '' - - - id: location - var_type: string - description: '' - - - id: product - var_type: string - description: '' - returns: - - - var_type: string - description: 'The formatted product resource.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::productSetName()' - name: 'static::productSetName' - id: productSetName - summary: |- - Formats a string containing the fully-qualified path to represent a product_set - resource. - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - parameters: - - - id: project - var_type: string - description: '' - - - id: location - var_type: string - description: '' - - - id: productSet - var_type: string - description: '' - returns: - - - var_type: string - description: 'The formatted product_set resource.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::referenceImageName()' - name: 'static::referenceImageName' - id: referenceImageName - summary: |- - Formats a string containing the fully-qualified path to represent a - reference_image resource. - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - parameters: - - - id: project - var_type: string - description: '' - - - id: location - var_type: string - description: '' - - - id: product - var_type: string - description: '' - - - id: referenceImage - var_type: string - description: '' - returns: - - - var_type: string - description: 'The formatted reference_image resource.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::parseName()' - name: 'static::parseName' - id: parseName - summary: |- - Parses a formatted name string and returns an associative array of the components in the name. - - The following name formats are supported: - Template: Pattern - - location: projects/{project}/locations/{location} - - product: projects/{project}/locations/{location}/products/{product} - - productSet: projects/{project}/locations/{location}/productSets/{product_set} - - referenceImage: projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image} - - The optional $template argument can be supplied to specify a particular pattern, - and must match one of the templates listed above. If no $template argument is - provided, or if the $template argument does not match one of the templates - listed, then parseName will check each of the supported templates, and return - the first match. - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: method - langs: - - php - syntax: - parameters: - - - id: formattedName - var_type: string - description: 'The formatted name string' - - - id: template - var_type: string - description: 'Optional name of template to match' - returns: - - - var_type: array - description: 'An associative array from name component IDs to component values.' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::SERVICE_NAME' - name: SERVICE_NAME - id: SERVICE_NAME - summary: 'The name of the service.' - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: const - langs: - - php - syntax: - content: "Value: 'google.cloud.vision.v1.ProductSearch'" - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::SERVICE_ADDRESS' - name: SERVICE_ADDRESS - id: SERVICE_ADDRESS - summary: 'The default address of the service.' - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: const - langs: - - php - syntax: - content: "Value: 'vision.googleapis.com'" - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::DEFAULT_SERVICE_PORT' - name: DEFAULT_SERVICE_PORT - id: DEFAULT_SERVICE_PORT - summary: 'The default port of the service.' - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: const - langs: - - php - syntax: - content: 'Value: 443' - - - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::CODEGEN_NAME' - name: CODEGEN_NAME - id: CODEGEN_NAME - summary: 'The name of the code generator, to be included in the agent header.' - parent: \Google\Cloud\Vision\V1\ProductSearchClient - type: const - langs: - - php - syntax: - content: "Value: 'gapic'" diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml index c203409afc69..fc56e3de4970 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml @@ -114,7 +114,8 @@ items: name: getProductSet id: getProductSet summary: |- - The resource name of a ProductSet to be searched for similar images. + The resource name of a ProductSet to + be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. @@ -131,7 +132,8 @@ items: name: setProductSet id: setProductSet summary: |- - The resource name of a ProductSet to be searched for similar images. + The resource name of a ProductSet to + be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. diff --git a/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml b/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml index 29d2597a74d3..17266226f633 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml @@ -132,10 +132,10 @@ items: name: getBoundingPolys id: getBoundingPolys summary: |- - Optional. Bounding polygons around the areas of interest in the reference image. - - If this field is empty, the system will try to detect regions of + Optional. Bounding polygons around the areas of interest in the reference + image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 @@ -153,10 +153,10 @@ items: name: setBoundingPolys id: setBoundingPolys summary: |- - Optional. Bounding polygons around the areas of interest in the reference image. - - If this field is empty, the system will try to detect regions of + Optional. Bounding polygons around the areas of interest in the reference + image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 diff --git a/dev/tests/fixtures/docfx/Vision/V1.RemoveProductFromProductSetRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.RemoveProductFromProductSetRequest.yml index 39a85311a089..7a64a38365d7 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.RemoveProductFromProductSetRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.RemoveProductFromProductSetRequest.yml @@ -87,7 +87,8 @@ items: name: getProduct id: getProduct summary: |- - Required. The resource name for the Product to be removed from this ProductSet. + Required. The resource name for the Product to be removed from this + ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` @@ -104,7 +105,8 @@ items: name: setProduct id: setProduct summary: |- - Required. The resource name for the Product to be removed from this ProductSet. + Required. The resource name for the Product to be removed from this + ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` @@ -144,7 +146,8 @@ items: id: product var_type: string description: |- - Required. The resource name for the Product to be removed from this ProductSet. + Required. The resource name for the Product to be removed from this + ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` diff --git a/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml index f38784a8fd69..016d267d8f0d 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml @@ -69,7 +69,7 @@ items: - id: '↳ violence' var_type: int - description: 'Likelihood that this image contains violent content.' + description: 'Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.' - id: '↳ racy' var_type: int @@ -183,7 +183,10 @@ items: uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolence()' name: getViolence id: getViolence - summary: 'Likelihood that this image contains violent content.' + summary: |- + Likelihood that this image contains violent content. Violent content may + include death, serious harm, or injury to individuals or groups of + individuals. parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation type: method langs: @@ -196,7 +199,10 @@ items: uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolence()' name: setViolence id: setViolence - summary: 'Likelihood that this image contains violent content.' + summary: |- + Likelihood that this image contains violent content. Violent content may + include death, serious harm, or injury to individuals or groups of + individuals. parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation type: method langs: diff --git a/dev/tests/fixtures/docfx/Vision/V1.Symbol.yml b/dev/tests/fixtures/docfx/Vision/V1.Symbol.yml index 76f2fc9665b3..fbfde169e500 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Symbol.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Symbol.yml @@ -49,7 +49,7 @@ items: - id: '↳ bounding_box' var_type: 'Google\Cloud\Vision\V1\BoundingPoly' - description: "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." + description: "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * * when the text is horizontal it might look like: 0----1 | | 3----2 * * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." - id: '↳ text' var_type: string diff --git a/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml index 623b3da20e3b..83918cb9afb9 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml @@ -12,8 +12,9 @@ items: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer - to the TextAnnotation.TextProperty message definition below for more - detail. + to the + TextAnnotation.TextProperty + message definition below for more detail. Generated from protobuf message google.cloud.vision.v1.TextAnnotation type: class diff --git a/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml b/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml index d8263cefe5e2..3f13483ca537 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml @@ -42,7 +42,7 @@ items: - id: '↳ advanced_ocr_options' var_type: array - description: 'A list of advanced OCR options to fine-tune OCR behavior.' + description: 'A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.' - uid: '\Google\Cloud\Vision\V1\TextDetectionParams::getEnableTextDetectionConfidenceScore()' name: getEnableTextDetectionConfidenceScore @@ -84,7 +84,14 @@ items: uid: '\Google\Cloud\Vision\V1\TextDetectionParams::getAdvancedOcrOptions()' name: getAdvancedOcrOptions id: getAdvancedOcrOptions - summary: 'A list of advanced OCR options to fine-tune OCR behavior.' + summary: |- + A list of advanced OCR options to further fine-tune OCR behavior. + + Current valid values are: + - `legacy_layout`: a heuristics layout detection algorithm, which serves as + an alternative to the current ML-based layout detection algorithm. + Customers can choose the best suitable layout algorithm based on their + situation. parent: \Google\Cloud\Vision\V1\TextDetectionParams type: method langs: @@ -97,7 +104,14 @@ items: uid: '\Google\Cloud\Vision\V1\TextDetectionParams::setAdvancedOcrOptions()' name: setAdvancedOcrOptions id: setAdvancedOcrOptions - summary: 'A list of advanced OCR options to fine-tune OCR behavior.' + summary: |- + A list of advanced OCR options to further fine-tune OCR behavior. + + Current valid values are: + - `legacy_layout`: a heuristics layout detection algorithm, which serves as + an alternative to the current ML-based layout detection algorithm. + Customers can choose the best suitable layout algorithm based on their + situation. parent: \Google\Cloud\Vision\V1\TextDetectionParams type: method langs: diff --git a/dev/tests/fixtures/docfx/Vision/V1.WebDetectionParams.yml b/dev/tests/fixtures/docfx/Vision/V1.WebDetectionParams.yml index 75342d17039c..e86816e0eb56 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.WebDetectionParams.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.WebDetectionParams.yml @@ -35,12 +35,12 @@ items: - id: '↳ include_geo_results' var_type: bool - description: 'Whether to include results derived from the geo information in the image.' + description: 'This field has no effect on results.' - uid: '\Google\Cloud\Vision\V1\WebDetectionParams::getIncludeGeoResults()' name: getIncludeGeoResults id: getIncludeGeoResults - summary: 'Whether to include results derived from the geo information in the image.' + summary: 'This field has no effect on results.' parent: \Google\Cloud\Vision\V1\WebDetectionParams type: method langs: @@ -53,7 +53,7 @@ items: uid: '\Google\Cloud\Vision\V1\WebDetectionParams::setIncludeGeoResults()' name: setIncludeGeoResults id: setIncludeGeoResults - summary: 'Whether to include results derived from the geo information in the image.' + summary: 'This field has no effect on results.' parent: \Google\Cloud\Vision\V1\WebDetectionParams type: method langs: diff --git a/dev/tests/fixtures/docfx/Vision/V1.Word.yml b/dev/tests/fixtures/docfx/Vision/V1.Word.yml index 4d7e40ca90b3..779e9d649951 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Word.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Word.yml @@ -49,7 +49,7 @@ items: - id: '↳ bounding_box' var_type: 'Google\Cloud\Vision\V1\BoundingPoly' - description: "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." + description: "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * * when the text is horizontal it might look like: 0----1 | | 3----2 * * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." - id: '↳ symbols' var_type: 'array<Google\Cloud\Vision\V1\Symbol>' diff --git a/dev/tests/fixtures/docfx/Vision/toc.yml b/dev/tests/fixtures/docfx/Vision/toc.yml index 7c4cf2f1169f..53f5059ad604 100644 --- a/dev/tests/fixtures/docfx/Vision/toc.yml +++ b/dev/tests/fixtures/docfx/Vision/toc.yml @@ -25,11 +25,9 @@ - uid: \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient name: 'ImageAnnotatorClient (beta)' - status: beta - uid: \Google\Cloud\Vision\V1\Client\ProductSearchClient name: 'ProductSearchClient (beta)' - status: beta - name: Messages uid: 'messages:Google\Cloud\Vision\V1' diff --git a/dev/tests/fixtures/phpdoc/newclient.xml b/dev/tests/fixtures/phpdoc/newclient.xml index 5a09e22f5d19..db8c6ef80dc4 100644 --- a/dev/tests/fixtures/phpdoc/newclient.xml +++ b/dev/tests/fixtures/phpdoc/newclient.xml @@ -1,4 +1,4 @@ - + @@ -13,10 +13,10 @@ - + SecretManagerServiceClient \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient - + Service Description: Secret Manager Service Manages secrets and operations using those secrets. Implements a REST model with the following objects: @@ -30,12 +30,8 @@ calls that map to API methods. Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - -This class is currently experimental and may be subject to changes. See {@see \Google\Cloud\SecretManager\V1\SecretManagerServiceClient} for the stable -implementation - - +contained within formatted names that are returned by the API. + @@ -55,56 +51,68 @@ implementation - + SERVICE_NAME \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::SERVICE_NAME 'google.cloud.secretmanager.v1.SecretManagerService' - + The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::SERVICE_ADDRESS 'secretmanager.googleapis.com' - + The default address of the service. - + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::SERVICE_ADDRESS_TEMPLATE + 'secretmanager.UNIVERSE_DOMAIN' + + The address template of the service. + + - + DEFAULT_SERVICE_PORT \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::DEFAULT_SERVICE_PORT 443 - + The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::CODEGEN_NAME 'gapic' - + The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform'] - + The default scopes required by the service. @@ -112,28 +120,55 @@ implementation - + getClientDefaults \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getClientDefaults() - + - + + locationName + \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::locationName() + + + project + + string + + + + location + + string + + + + Formats a string containing the fully-qualified path to represent a location +resource. + + + + + + + + + projectName \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectName() - + project string - + Formats a string containing the fully-qualified path to represent a project resource. @@ -143,23 +178,159 @@ resource. - + + projectLocationSecretName + \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectLocationSecretName() + + + project + + string + + + + location + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a +project_location_secret resource. + + + + + + + + + + + projectLocationSecretSecretVersionName + \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectLocationSecretSecretVersionName() + + + project + + string + + + + location + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_location_secret_secret_version resource. + + + + + + + + + + + + projectSecretName + \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectSecretName() + + + project + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret resource. + + + + + + + + + + projectSecretSecretVersionName + \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectSecretSecretVersionName() + + + project + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret_secret_version resource. + + + + + + + + + + secretName \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::secretName() - + project string - + secret string - + Formats a string containing the fully-qualified path to represent a secret resource. @@ -170,29 +341,29 @@ resource. - + secretVersionName \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::secretVersionName() - + project string - + secret string - + secretVersion string - + Formats a string containing the fully-qualified path to represent a secret_version resource. @@ -204,23 +375,23 @@ secret_version resource. - + topicName \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::topicName() - + project string - + topic string - + Formats a string containing the fully-qualified path to represent a topic resource. @@ -231,27 +402,32 @@ resource. - + parseName \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::parseName() - + formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern +- location: projects/{project}/locations/{location} - project: projects/{project} +- projectLocationSecret: projects/{project}/locations/{location}/secrets/{secret} +- projectLocationSecretSecretVersion: projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version} +- projectSecret: projects/{project}/secrets/{secret} +- projectSecretSecretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - secret: projects/{project}/secrets/{secret} - secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - topic: projects/{project}/topics/{topic} @@ -269,17 +445,17 @@ the first match. - + __construct \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::__construct() - + options [] array - + Constructor. @@ -288,53 +464,56 @@ the first match. - + __call \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::__call() - + method mixed - + args mixed - + Handles execution of the async variants for each documented method. - + accessSecretVersion \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::accessSecretVersion() - + request \Google\Cloud\SecretManager\V1\AccessSecretVersionRequest - + callOptions [] array - - Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data. - `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently + + Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + This call returns the secret data. + +`projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::accessSecretVersionAsync()} . - + + @@ -342,28 +521,30 @@ The async variant is - + addSecretVersion \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::addSecretVersion() - + request \Google\Cloud\SecretManager\V1\AddSecretVersionRequest - + callOptions [] array - - Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] containing secret data and attaches -it to an existing [Secret][google.cloud.secretmanager.v1.Secret]. + + Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] +containing secret data and attaches it to an existing +[Secret][google.cloud.secretmanager.v1.Secret]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::addSecretVersionAsync()} . - + + @@ -371,26 +552,28 @@ it to an existing [Secret][google.cloud.secretmanager.v1.Secret]. - + createSecret \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::createSecret() - + request \Google\Cloud\SecretManager\V1\CreateSecretRequest - + callOptions [] array - - Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + + Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no +[SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::createSecretAsync()} . - + + @@ -398,57 +581,60 @@ it to an existing [Secret][google.cloud.secretmanager.v1.Secret]. - + deleteSecret \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::deleteSecret() - + request \Google\Cloud\SecretManager\V1\DeleteSecretRequest - + callOptions [] array - + Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::deleteSecretAsync()} . - + + - + destroySecretVersion \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::destroySecretVersion() - + request \Google\Cloud\SecretManager\V1\DestroySecretVersionRequest - + callOptions [] array - + Destroys a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to -[DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] and irrevocably destroys the -secret data. + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to +[DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] +and irrevocably destroys the secret data. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::destroySecretVersionAsync()} . - + + @@ -456,30 +642,32 @@ The async variant is - + disableSecretVersion \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::disableSecretVersion() - + request \Google\Cloud\SecretManager\V1\DisableSecretVersionRequest - + callOptions [] array - + Disables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::disableSecretVersionAsync()} . - + + @@ -487,30 +675,32 @@ The async variant is - + enableSecretVersion \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::enableSecretVersion() - + request \Google\Cloud\SecretManager\V1\EnableSecretVersionRequest - + callOptions [] array - + Enables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::enableSecretVersionAsync()} . - + + @@ -518,28 +708,29 @@ The async variant is - + getIamPolicy \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getIamPolicy() - + request \Google\Cloud\Iam\V1\GetIamPolicyRequest - + callOptions [] array - + Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getIamPolicyAsync()} . - + + @@ -547,26 +738,27 @@ The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerSe - + getSecret \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecret() - + request \Google\Cloud\SecretManager\V1\GetSecretRequest - + callOptions [] array - + Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretAsync()} . - + + @@ -574,30 +766,32 @@ The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerSe - + getSecretVersion \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretVersion() - + request \Google\Cloud\SecretManager\V1\GetSecretVersionRequest - + callOptions [] array - - Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Gets metadata for a +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretVersionAsync()} . - + + @@ -605,28 +799,29 @@ The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerSe - + listSecretVersions \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretVersions() - + request \Google\Cloud\SecretManager\V1\ListSecretVersionsRequest - + callOptions [] array - - Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret -data. + + Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This +call does not return secret data. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretVersionsAsync()} . - + + @@ -634,26 +829,27 @@ data. - + listSecrets \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecrets() - + request \Google\Cloud\SecretManager\V1\ListSecretsRequest - + callOptions [] array - + Lists [Secrets][google.cloud.secretmanager.v1.Secret]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretsAsync()} . - + + @@ -661,30 +857,33 @@ data. - + setIamPolicy \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicy() - + request \Google\Cloud\Iam\V1\SetIamPolicyRequest - + callOptions [] array - + Sets the access control policy on the specified secret. Replaces any existing policy. - Permissions on [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced according -to the policy set on the associated [Secret][google.cloud.secretmanager.v1.Secret]. + Permissions on +[SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced +according to the policy set on the associated +[Secret][google.cloud.secretmanager.v1.Secret]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicyAsync()} . - + + @@ -692,23 +891,23 @@ The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerSe - + testIamPermissions \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::testIamPermissions() - + request \Google\Cloud\Iam\V1\TestIamPermissionsRequest - + callOptions [] array - + Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. @@ -719,7 +918,8 @@ may "fail open" without warning. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::testIamPermissionsAsync()} . - + + @@ -727,26 +927,28 @@ The async variant is - + updateSecret \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecret() - + request \Google\Cloud\SecretManager\V1\UpdateSecretRequest - + callOptions [] array - - Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret]. + + Updates metadata of an existing +[Secret][google.cloud.secretmanager.v1.Secret]. The async variant is {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecretAsync()} . - + + @@ -765,15 +967,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -789,15 +991,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -813,15 +1015,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -837,15 +1039,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -861,15 +1063,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -885,15 +1087,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -909,15 +1111,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -933,15 +1135,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -957,15 +1159,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -981,15 +1183,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -1005,15 +1207,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -1029,15 +1231,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -1053,15 +1255,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -1077,15 +1279,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -1101,15 +1303,15 @@ The async variant is - optionalArgs = [] - + optionalArgs + [] array - + @@ -1119,7 +1321,7 @@ The async variant is - + @@ -1134,10 +1336,10 @@ The async variant is - + SecretManagerServiceGapicClient \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + Service Description: Secret Manager Service Manages secrets and operations using those secrets. Implements a REST model with the following objects: @@ -1161,120 +1363,185 @@ try { Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - -This service has a new (beta) implementation. See {@see \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient} to use the new -surface. - +contained within formatted names that are returned by the API. + + - + SERVICE_NAME \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::SERVICE_NAME 'google.cloud.secretmanager.v1.SecretManagerService' - + The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS 'secretmanager.googleapis.com' - + The default address of the service. - + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS_TEMPLATE + 'secretmanager.UNIVERSE_DOMAIN' + + The address template of the service. + + - + DEFAULT_SERVICE_PORT \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::DEFAULT_SERVICE_PORT 443 - + The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::CODEGEN_NAME 'gapic' - + The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform'] - + The default scopes required by the service. - + + locationNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$locationNameTemplate + + + + + + + + + projectNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectNameTemplate - + + + + + + + + + projectLocationSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectLocationSecretNameTemplate + + + + + + + + + + projectLocationSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectLocationSecretSecretVersionNameTemplate + + - + + projectSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectSecretNameTemplate + + + + + + + + + + projectSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectSecretSecretVersionNameTemplate + + + + + + + + + secretNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$secretNameTemplate - + - + secretVersionNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$secretVersionNameTemplate - + - + topicNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$topicNameTemplate - + - + pathTemplateMap \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$pathTemplateMap - + @@ -1282,83 +1549,165 @@ surface. - + getClientDefaults \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getClientDefaults() - + - + + getLocationNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getLocationNameTemplate() + + + + + + + + + getProjectNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectNameTemplate() - + - - getSecretNameTemplate - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretNameTemplate() + + getProjectLocationSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectLocationSecretNameTemplate() - + - - getSecretVersionNameTemplate - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretVersionNameTemplate() + + getProjectLocationSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectLocationSecretSecretVersionNameTemplate() - + - - getTopicNameTemplate - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getTopicNameTemplate() + + getProjectSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectSecretNameTemplate() - + - - getPathTemplateMap - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getPathTemplateMap() + + getProjectSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectSecretSecretVersionNameTemplate() - + - - projectName + + getSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretNameTemplate() + + + + + + + + + + getSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretVersionNameTemplate() + + + + + + + + + + getTopicNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getTopicNameTemplate() + + + + + + + + + + getPathTemplateMap + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getPathTemplateMap() + + + + + + + + + + locationName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::locationName() + + + project + + string + + + + location + + string + + + + Formats a string containing the fully-qualified path to represent a location +resource. + + + + + + + + + + projectName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectName() - + project string - + Formats a string containing the fully-qualified path to represent a project resource. @@ -1368,23 +1717,159 @@ resource. - + + projectLocationSecretName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectLocationSecretName() + + + project + + string + + + + location + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a +project_location_secret resource. + + + + + + + + + + + projectLocationSecretSecretVersionName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectLocationSecretSecretVersionName() + + + project + + string + + + + location + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_location_secret_secret_version resource. + + + + + + + + + + + + projectSecretName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectSecretName() + + + project + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret resource. + + + + + + + + + + projectSecretSecretVersionName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectSecretSecretVersionName() + + + project + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret_secret_version resource. + + + + + + + + + + secretName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::secretName() - + project string - + secret string - + Formats a string containing the fully-qualified path to represent a secret resource. @@ -1395,29 +1880,29 @@ resource. - + secretVersionName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::secretVersionName() - + project string - + secret string - + secretVersion string - + Formats a string containing the fully-qualified path to represent a secret_version resource. @@ -1429,23 +1914,23 @@ secret_version resource. - + topicName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::topicName() - + project string - + topic string - + Formats a string containing the fully-qualified path to represent a topic resource. @@ -1456,27 +1941,32 @@ resource. - + parseName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::parseName() - + formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern +- location: projects/{project}/locations/{location} - project: projects/{project} +- projectLocationSecret: projects/{project}/locations/{location}/secrets/{secret} +- projectLocationSecretSecretVersion: projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version} +- projectSecret: projects/{project}/secrets/{secret} +- projectSecretSecretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - secret: projects/{project}/secrets/{secret} - secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - topic: projects/{project}/topics/{topic} @@ -1494,17 +1984,17 @@ the first match. - + __construct \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::__construct() - + options [] array - + Constructor. @@ -1513,25 +2003,27 @@ the first match. - + accessSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::accessSecretVersion() - + name string - + optionalArgs [] array - - Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data. - `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently + + Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + This call returns the secret data. + +`projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Sample code: @@ -1544,7 +2036,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -1552,31 +2044,32 @@ try { - + addSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::addSecretVersion() - + parent string - + payload \Google\Cloud\SecretManager\V1\SecretPayload - + optionalArgs [] array - - Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] containing secret data and attaches -it to an existing [Secret][google.cloud.secretmanager.v1.Secret]. + + Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] +containing secret data and attaches it to an existing +[Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -1588,8 +2081,8 @@ try { $secretManagerServiceClient->close(); } ``` - - + + @@ -1597,36 +2090,37 @@ try { - + createSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::createSecret() - + parent string - + secretId string - + secret \Google\Cloud\SecretManager\V1\Secret - + optionalArgs [] array - - Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + + Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no +[SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -1639,9 +2133,9 @@ try { $secretManagerServiceClient->close(); } ``` - + - + @@ -1649,23 +2143,23 @@ try { - + deleteSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::deleteSecret() - + name string - + optionalArgs [] array - + Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -1677,34 +2171,35 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + destroySecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::destroySecretVersion() - + name string - + optionalArgs [] array - + Destroys a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to -[DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] and irrevocably destroys the -secret data. + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to +[DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] +and irrevocably destroys the secret data. Sample code: ``` @@ -1716,33 +2211,34 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + disableSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::disableSecretVersion() - + name string - + optionalArgs [] array - + Disables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. Sample code: @@ -1755,33 +2251,34 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + enableSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::enableSecretVersion() - + name string - + optionalArgs [] array - + Enables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. Sample code: @@ -1794,31 +2291,31 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + getIamPolicy \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getIamPolicy() - + resource string - + optionalArgs [] array - + Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. @@ -1840,23 +2337,23 @@ try { - + getSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecret() - + name string - + optionalArgs [] array - + Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -1868,7 +2365,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -1876,24 +2373,25 @@ try { - + getSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretVersion() - + name string - + optionalArgs [] array - - Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Gets metadata for a +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. @@ -1907,7 +2405,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -1915,25 +2413,25 @@ try { - + listSecretVersions \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::listSecretVersions() - + parent string - + optionalArgs [] array - - Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret -data. + + Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This +call does not return secret data. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -1956,7 +2454,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -1964,23 +2462,23 @@ try { - + listSecrets \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::listSecrets() - + parent string - + optionalArgs [] array - + Lists [Secrets][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -2004,7 +2502,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -2012,33 +2510,35 @@ try { - + setIamPolicy \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::setIamPolicy() - + resource string - + policy \Google\Cloud\Iam\V1\Policy - + optionalArgs [] array - + Sets the access control policy on the specified secret. Replaces any existing policy. - Permissions on [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced according -to the policy set on the associated [Secret][google.cloud.secretmanager.v1.Secret]. + Permissions on +[SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced +according to the policy set on the associated +[Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -2060,29 +2560,29 @@ try { - + testIamPermissions \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::testIamPermissions() - + resource string - + permissions string[] - + optionalArgs [] array - + Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. @@ -2111,30 +2611,31 @@ try { - + updateSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::updateSecret() - + secret \Google\Cloud\SecretManager\V1\Secret - + updateMask \Google\Protobuf\FieldMask - + optionalArgs [] array - - Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret]. + + Updates metadata of an existing +[Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -2146,7 +2647,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -2186,111 +2687,178 @@ try { \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + SERVICE_NAME \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::SERVICE_NAME 'google.cloud.secretmanager.v1.SecretManagerService' - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS 'secretmanager.googleapis.com' - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient The default address of the service. - + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS_TEMPLATE + 'secretmanager.UNIVERSE_DOMAIN' + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + The address template of the service. + + - + DEFAULT_SERVICE_PORT \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::DEFAULT_SERVICE_PORT 443 - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::CODEGEN_NAME 'gapic' - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform'] - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient The default scopes required by the service. - + + locationNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$locationNameTemplate + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + projectNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectNameTemplate - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + projectLocationSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectLocationSecretNameTemplate + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + projectLocationSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectLocationSecretSecretVersionNameTemplate + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + projectSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectSecretNameTemplate + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + projectSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$projectSecretSecretVersionNameTemplate + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + secretNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$secretNameTemplate - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + secretVersionNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$secretVersionNameTemplate - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + topicNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$topicNameTemplate - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + pathTemplateMap \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::$pathTemplateMap - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient @@ -2298,109 +2866,327 @@ try { - + getClientDefaults \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getClientDefaults() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + + getLocationNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getLocationNameTemplate() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + getProjectNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectNameTemplate() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + getProjectLocationSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectLocationSecretNameTemplate() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + getProjectLocationSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectLocationSecretSecretVersionNameTemplate() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + getProjectSecretNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectSecretNameTemplate() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + + + + + + + + getProjectSecretSecretVersionNameTemplate + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getProjectSecretSecretVersionNameTemplate() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + getSecretNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretNameTemplate() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + getSecretVersionNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretVersionNameTemplate() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + getTopicNameTemplate \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getTopicNameTemplate() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - + getPathTemplateMap \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getPathTemplateMap() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient - - projectName - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectName() + + locationName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::locationName() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient project string - - Formats a string containing the fully-qualified path to represent a project + + location + + string + + + + Formats a string containing the fully-qualified path to represent a location resource. - + + - - secretName - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::secretName() + + projectName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectName() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient project string - + + Formats a string containing the fully-qualified path to represent a project +resource. + + + + + + + + + projectLocationSecretName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectLocationSecretName() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + project + + string + + + + location + + string + + + secret string - + + Formats a string containing the fully-qualified path to represent a +project_location_secret resource. + + + + + + + + + + + projectLocationSecretSecretVersionName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectLocationSecretSecretVersionName() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + project + + string + + + + location + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_location_secret_secret_version resource. + + + + + + + + + + + + projectSecretName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectSecretName() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + project + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret resource. + + + + + + + + + + projectSecretSecretVersionName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::projectSecretSecretVersionName() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + project + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret_secret_version resource. + + + + + + + + + + + secretName + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::secretName() + + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + project + + string + + + + secret + + string + + + Formats a string containing the fully-qualified path to represent a secret resource. @@ -2411,29 +3197,29 @@ resource. - + secretVersionName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::secretVersionName() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient project string - + secret string - + secretVersion string - + Formats a string containing the fully-qualified path to represent a secret_version resource. @@ -2445,23 +3231,23 @@ secret_version resource. - + topicName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::topicName() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient project string - + topic string - + Formats a string containing the fully-qualified path to represent a topic resource. @@ -2472,27 +3258,32 @@ resource. - + parseName \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::parseName() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern +- location: projects/{project}/locations/{location} - project: projects/{project} +- projectLocationSecret: projects/{project}/locations/{location}/secrets/{secret} +- projectLocationSecretSecretVersion: projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version} +- projectSecret: projects/{project}/secrets/{secret} +- projectSecretSecretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - secret: projects/{project}/secrets/{secret} - secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} - topic: projects/{project}/topics/{topic} @@ -2510,17 +3301,17 @@ the first match. - + __construct \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::__construct() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient options [] array - + Constructor. @@ -2529,25 +3320,27 @@ the first match. - + accessSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::accessSecretVersion() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - - Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data. - `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently + + Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + This call returns the secret data. + +`projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Sample code: @@ -2560,7 +3353,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -2568,31 +3361,32 @@ try { - + addSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::addSecretVersion() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient parent string - + payload \Google\Cloud\SecretManager\V1\SecretPayload - + optionalArgs [] array - - Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] containing secret data and attaches -it to an existing [Secret][google.cloud.secretmanager.v1.Secret]. + + Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] +containing secret data and attaches it to an existing +[Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -2604,8 +3398,8 @@ try { $secretManagerServiceClient->close(); } ``` - - + + @@ -2613,36 +3407,37 @@ try { - + createSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::createSecret() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient parent string - + secretId string - + secret \Google\Cloud\SecretManager\V1\Secret - + optionalArgs [] array - - Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + + Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no +[SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -2655,9 +3450,9 @@ try { $secretManagerServiceClient->close(); } ``` - + - + @@ -2665,23 +3460,23 @@ try { - + deleteSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::deleteSecret() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Deletes a [Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -2693,34 +3488,35 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + destroySecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::destroySecretVersion() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Destroys a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to -[DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] and irrevocably destroys the -secret data. + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to +[DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED] +and irrevocably destroys the secret data. Sample code: ``` @@ -2732,33 +3528,34 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + disableSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::disableSecretVersion() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Disables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]. Sample code: @@ -2771,33 +3568,34 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + enableSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::enableSecretVersion() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Enables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to + Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]. Sample code: @@ -2810,31 +3608,31 @@ try { $secretManagerServiceClient->close(); } ``` - - + + - + getIamPolicy \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getIamPolicy() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient resource string - + optionalArgs [] array - + Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. @@ -2856,23 +3654,23 @@ try { - + getSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecret() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -2884,7 +3682,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -2892,24 +3690,25 @@ try { - + getSecretVersion \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::getSecretVersion() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - - Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + + Gets metadata for a +[SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. @@ -2923,7 +3722,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -2931,25 +3730,25 @@ try { - + listSecretVersions \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::listSecretVersions() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient parent string - + optionalArgs [] array - - Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret -data. + + Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This +call does not return secret data. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -2972,7 +3771,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -2980,23 +3779,23 @@ try { - + listSecrets \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::listSecrets() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient parent string - + optionalArgs [] array - + Lists [Secrets][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -3020,7 +3819,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -3028,33 +3827,35 @@ try { - + setIamPolicy \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::setIamPolicy() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient resource string - + policy \Google\Cloud\Iam\V1\Policy - + optionalArgs [] array - + Sets the access control policy on the specified secret. Replaces any existing policy. - Permissions on [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced according -to the policy set on the associated [Secret][google.cloud.secretmanager.v1.Secret]. + Permissions on +[SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced +according to the policy set on the associated +[Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` @@ -3076,29 +3877,29 @@ try { - + testIamPermissions \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::testIamPermissions() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient resource string - + permissions string[] - + optionalArgs [] array - + Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. @@ -3127,30 +3928,31 @@ try { - + updateSecret \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient::updateSecret() - \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1\Gapic\SecretManagerServiceGapicClient secret \Google\Cloud\SecretManager\V1\Secret - + updateMask \Google\Protobuf\FieldMask - + optionalArgs [] array - - Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret]. + + Updates metadata of an existing +[Secret][google.cloud.secretmanager.v1.Secret]. Sample code: ``` $secretManagerServiceClient = new SecretManagerServiceClient(); @@ -3162,7 +3964,7 @@ try { $secretManagerServiceClient->close(); } ``` - + @@ -3176,7 +3978,7 @@ try { - + @@ -3191,10 +3993,10 @@ try { - + SecretManagerServiceGapicClient \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + Service Description: Secret Manager Service Manages secrets and operations using those secrets. Implements a REST model with the following objects: @@ -3220,105 +4022,118 @@ assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API. + - + SERVICE_NAME \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::SERVICE_NAME 'google.cloud.secrets.v1beta1.SecretManagerService' - + The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS 'secretmanager.googleapis.com' - + The default address of the service. - + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS_TEMPLATE + 'secretmanager.UNIVERSE_DOMAIN' + + The address template of the service. + + - + DEFAULT_SERVICE_PORT \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::DEFAULT_SERVICE_PORT 443 - + The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::CODEGEN_NAME 'gapic' - + The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform'] - + The default scopes required by the service. - + projectNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$projectNameTemplate - + - + secretNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$secretNameTemplate - + - + secretVersionNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$secretVersionNameTemplate - + - + pathTemplateMap \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$pathTemplateMap - + @@ -3326,72 +4141,72 @@ contained within formatted names that are returned by the API. - + getClientDefaults \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getClientDefaults() - + - + getProjectNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getProjectNameTemplate() - + - + getSecretNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecretNameTemplate() - + - + getSecretVersionNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecretVersionNameTemplate() - + - + getPathTemplateMap \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getPathTemplateMap() - + - + projectName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::projectName() - + project string - + Formats a string containing the fully-qualified path to represent a project resource. @@ -3402,23 +4217,23 @@ resource. - + secretName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::secretName() - + project string - + secret string - + Formats a string containing the fully-qualified path to represent a secret resource. @@ -3430,29 +4245,29 @@ resource. - + secretVersionName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::secretVersionName() - + project string - + secret string - + secretVersion string - + Formats a string containing the fully-qualified path to represent a secret_version resource. @@ -3465,23 +4280,23 @@ secret_version resource. - + parseName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::parseName() - + formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -3503,17 +4318,17 @@ the first match. - + __construct \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::__construct() - + options [] array - + Constructor. @@ -3523,23 +4338,23 @@ the first match. - + accessSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::accessSecretVersion() - + name string - + optionalArgs [] array - + Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the secret data. `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the `latest` [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. @@ -3563,29 +4378,29 @@ try { - + addSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::addSecretVersion() - + parent string - + payload \Google\Cloud\SecretManager\V1beta1\SecretPayload - + optionalArgs [] array - + Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: @@ -3609,35 +4424,35 @@ try { - + createSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::createSecret() - + parent string - + secretId string - + secret \Google\Cloud\SecretManager\V1beta1\Secret - + optionalArgs [] array - + Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. Sample code: ``` @@ -3662,23 +4477,23 @@ try { - + deleteSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::deleteSecret() - + name string - + optionalArgs [] array - + Deletes a [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -3698,23 +4513,23 @@ try { - + destroySecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::destroySecretVersion() - + name string - + optionalArgs [] array - + Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably destroys the @@ -3739,23 +4554,23 @@ try { - + disableSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::disableSecretVersion() - + name string - + optionalArgs [] array - + Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED]. @@ -3779,23 +4594,23 @@ try { - + enableSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::enableSecretVersion() - + name string - + optionalArgs [] array - + Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED]. @@ -3819,23 +4634,23 @@ try { - + getIamPolicy \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getIamPolicy() - + resource string - + optionalArgs [] array - + Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. @@ -3858,23 +4673,23 @@ try { - + getSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecret() - + name string - + optionalArgs [] array - + Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -3895,23 +4710,23 @@ try { - + getSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecretVersion() - + name string - + optionalArgs [] array - + Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the `latest` [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. @@ -3935,23 +4750,23 @@ try { - + listSecretVersions \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::listSecretVersions() - + parent string - + optionalArgs [] array - + Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return secret data. Sample code: @@ -3985,23 +4800,23 @@ try { - + listSecrets \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::listSecrets() - + parent string - + optionalArgs [] array - + Lists [Secrets][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -4034,29 +4849,29 @@ try { - + setIamPolicy \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::setIamPolicy() - + resource string - + policy \Google\Cloud\Iam\V1\Policy - + optionalArgs [] array - + Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] are enforced according @@ -4083,29 +4898,29 @@ try { - + testIamPermissions \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::testIamPermissions() - + resource string - + permissions string[] - + optionalArgs [] array - + Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. @@ -4135,29 +4950,29 @@ try { - + updateSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::updateSecret() - + secret \Google\Cloud\SecretManager\V1beta1\Secret - + updateMask \Google\Protobuf\FieldMask - + optionalArgs [] array - + Updates metadata of an existing [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -4211,100 +5026,112 @@ try { \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + SERVICE_NAME \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::SERVICE_NAME 'google.cloud.secrets.v1beta1.SecretManagerService' - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS 'secretmanager.googleapis.com' - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient The default address of the service. - + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::SERVICE_ADDRESS_TEMPLATE + 'secretmanager.UNIVERSE_DOMAIN' + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + The address template of the service. + + - + DEFAULT_SERVICE_PORT \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::DEFAULT_SERVICE_PORT 443 - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::CODEGEN_NAME 'gapic' - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform'] - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient The default scopes required by the service. - + projectNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$projectNameTemplate - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + secretNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$secretNameTemplate - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + secretVersionNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$secretVersionNameTemplate - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + pathTemplateMap \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::$pathTemplateMap - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient @@ -4312,72 +5139,72 @@ try { - + getClientDefaults \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getClientDefaults() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + getProjectNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getProjectNameTemplate() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + getSecretNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecretNameTemplate() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + getSecretVersionNameTemplate \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecretVersionNameTemplate() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + getPathTemplateMap \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getPathTemplateMap() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient - + projectName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::projectName() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient project string - + Formats a string containing the fully-qualified path to represent a project resource. @@ -4388,23 +5215,23 @@ resource. - + secretName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::secretName() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient project string - + secret string - + Formats a string containing the fully-qualified path to represent a secret resource. @@ -4416,29 +5243,29 @@ resource. - + secretVersionName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::secretVersionName() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient project string - + secret string - + secretVersion string - + Formats a string containing the fully-qualified path to represent a secret_version resource. @@ -4451,23 +5278,23 @@ secret_version resource. - + parseName \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::parseName() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -4489,17 +5316,17 @@ the first match. - + __construct \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::__construct() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient options [] array - + Constructor. @@ -4509,23 +5336,23 @@ the first match. - + accessSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::accessSecretVersion() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the secret data. `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the `latest` [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. @@ -4549,29 +5376,29 @@ try { - + addSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::addSecretVersion() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient parent string - + payload \Google\Cloud\SecretManager\V1beta1\SecretPayload - + optionalArgs [] array - + Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: @@ -4595,35 +5422,35 @@ try { - + createSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::createSecret() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient parent string - + secretId string - + secret \Google\Cloud\SecretManager\V1beta1\Secret - + optionalArgs [] array - + Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. Sample code: ``` @@ -4648,23 +5475,23 @@ try { - + deleteSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::deleteSecret() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Deletes a [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -4684,23 +5511,23 @@ try { - + destroySecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::destroySecretVersion() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably destroys the @@ -4725,23 +5552,23 @@ try { - + disableSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::disableSecretVersion() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED]. @@ -4765,23 +5592,23 @@ try { - + enableSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::enableSecretVersion() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED]. @@ -4805,23 +5632,23 @@ try { - + getIamPolicy \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getIamPolicy() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient resource string - + optionalArgs [] array - + Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. @@ -4844,23 +5671,23 @@ try { - + getSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecret() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -4881,23 +5708,23 @@ try { - + getSecretVersion \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::getSecretVersion() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient name string - + optionalArgs [] array - + Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the `latest` [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. @@ -4921,23 +5748,23 @@ try { - + listSecretVersions \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::listSecretVersions() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient parent string - + optionalArgs [] array - + Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return secret data. Sample code: @@ -4971,23 +5798,23 @@ try { - + listSecrets \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::listSecrets() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient parent string - + optionalArgs [] array - + Lists [Secrets][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -5020,29 +5847,29 @@ try { - + setIamPolicy \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::setIamPolicy() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient resource string - + policy \Google\Cloud\Iam\V1\Policy - + optionalArgs [] array - + Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] are enforced according @@ -5069,29 +5896,29 @@ try { - + testIamPermissions \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::testIamPermissions() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient resource string - + permissions string[] - + optionalArgs [] array - + Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. @@ -5121,29 +5948,29 @@ try { - + updateSecret \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient::updateSecret() - \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient + \Google\Cloud\SecretManager\V1beta1\Gapic\SecretManagerServiceGapicClient secret \Google\Cloud\SecretManager\V1beta1\Secret - + updateMask \Google\Protobuf\FieldMask - + optionalArgs [] array - + Updates metadata of an existing [Secret][google.cloud.secrets.v1beta1.Secret]. Sample code: ``` @@ -5170,5 +5997,1470 @@ try { + + + + + + + + + + + + + + + + + + SecretManagerServiceClient + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient + + Service Description: Secret Manager Service + Manages secrets and operations using those secrets. Implements a REST +model with the following objects: + +* [Secret][google.cloud.secretmanager.v1beta2.Secret] +* [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] + +This class provides the ability to make remote calls to the backing service through method +calls that map to API methods. + +Many parameters require resource names to be formatted in a particular way. To +assist with these names, this class includes a format method for each type of +name, and additionally a parseName method to extract the individual identifiers +contained within formatted names that are returned by the API. + + + + + + + + + + + + + + + + + + + + + + + + + SERVICE_NAME + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::SERVICE_NAME + 'google.cloud.secretmanager.v1beta2.SecretManagerService' + + The name of the service. + + + + + + + SERVICE_ADDRESS + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::SERVICE_ADDRESS + 'secretmanager.googleapis.com' + + The default address of the service. + + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::SERVICE_ADDRESS_TEMPLATE + 'secretmanager.UNIVERSE_DOMAIN' + + The address template of the service. + + + + + + + DEFAULT_SERVICE_PORT + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::DEFAULT_SERVICE_PORT + 443 + + The default port of the service. + + + + + + + CODEGEN_NAME + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::CODEGEN_NAME + 'gapic' + + The name of the code generator, to be included in the agent header. + + + + + + + + serviceScopes + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::$serviceScopes + ['https://www.googleapis.com/auth/cloud-platform'] + + The default scopes required by the service. + + + + + + + + getClientDefaults + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getClientDefaults() + + + + + + + + + + locationName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::locationName() + + + project + + string + + + + location + + string + + + + Formats a string containing the fully-qualified path to represent a location +resource. + + + + + + + + + + + projectName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::projectName() + + + project + + string + + + + Formats a string containing the fully-qualified path to represent a project +resource. + + + + + + + + + + projectLocationSecretName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::projectLocationSecretName() + + + project + + string + + + + location + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a +project_location_secret resource. + + + + + + + + + + + + projectLocationSecretSecretVersionName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::projectLocationSecretSecretVersionName() + + + project + + string + + + + location + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_location_secret_secret_version resource. + + + + + + + + + + + + + projectSecretName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::projectSecretName() + + + project + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret resource. + + + + + + + + + + + projectSecretSecretVersionName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::projectSecretSecretVersionName() + + + project + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +project_secret_secret_version resource. + + + + + + + + + + + + secretName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::secretName() + + + project + + string + + + + secret + + string + + + + Formats a string containing the fully-qualified path to represent a secret +resource. + + + + + + + + + + + secretVersionName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::secretVersionName() + + + project + + string + + + + secret + + string + + + + secretVersion + + string + + + + Formats a string containing the fully-qualified path to represent a +secret_version resource. + + + + + + + + + + + + topicName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::topicName() + + + project + + string + + + + topic + + string + + + + Formats a string containing the fully-qualified path to represent a topic +resource. + + + + + + + + + + + parseName + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::parseName() + + + formattedName + + string + + + + template + null + string + + + + Parses a formatted name string and returns an associative array of the components in the name. + The following name formats are supported: +Template: Pattern +- location: projects/{project}/locations/{location} +- project: projects/{project} +- projectLocationSecret: projects/{project}/locations/{location}/secrets/{secret} +- projectLocationSecretSecretVersion: projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version} +- projectSecret: projects/{project}/secrets/{secret} +- projectSecretSecretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} +- secret: projects/{project}/secrets/{secret} +- secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} +- topic: projects/{project}/topics/{topic} + +The optional $template argument can be supplied to specify a particular pattern, +and must match one of the templates listed above. If no $template argument is +provided, or if the $template argument does not match one of the templates +listed, then parseName will check each of the supported templates, and return +the first match. + + + + + + + + + + + __construct + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::__construct() + + + options + [] + array + + + + Constructor. + + + + + + + + + + __call + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::__call() + + + method + + mixed + + + + args + + mixed + + + + Handles execution of the async variants for each documented method. + + + + + + + accessSecretVersion + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::accessSecretVersion() + + + request + + \Google\Cloud\SecretManager\V1beta2\AccessSecretVersionRequest + + + + callOptions + [] + array + + + + Accesses a +[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. This +call returns the secret data. + `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently +created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. + +The async variant is +{@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::accessSecretVersionAsync()} . + + + + + + + + + + + + addSecretVersion + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::addSecretVersion() + + + request + + \Google\Cloud\SecretManager\V1beta2\AddSecretVersionRequest + + + + callOptions + [] + array + + + + Creates a new +[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] +containing secret data and attaches it to an existing +[Secret][google.cloud.secretmanager.v1beta2.Secret]. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::addSecretVersionAsync()} +. + + + + + + + + + + + + createSecret + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::createSecret() + + + request + + \Google\Cloud\SecretManager\V1beta2\CreateSecretRequest + + + + callOptions + [] + array + + + + Creates a new [Secret][google.cloud.secretmanager.v1beta2.Secret] +containing no +[SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion]. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::createSecretAsync()} . + + + + + + + + + + + + deleteSecret + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::deleteSecret() + + + request + + \Google\Cloud\SecretManager\V1beta2\DeleteSecretRequest + + + + callOptions + [] + array + + + + Deletes a [Secret][google.cloud.secretmanager.v1beta2.Secret]. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::deleteSecretAsync()} . + + + + + + + + + + + destroySecretVersion + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::destroySecretVersion() + + + request + + \Google\Cloud\SecretManager\V1beta2\DestroySecretVersionRequest + + + + callOptions + [] + array + + + + Destroys a +[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. + Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of +the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to +[DESTROYED][google.cloud.secretmanager.v1beta2.SecretVersion.State.DESTROYED] +and irrevocably destroys the secret data. + +The async variant is +{@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::destroySecretVersionAsync()} . + + + + + + + + + + + + disableSecretVersion + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::disableSecretVersion() + + + request + + \Google\Cloud\SecretManager\V1beta2\DisableSecretVersionRequest + + + + callOptions + [] + array + + + + Disables a +[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. + Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of +the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to +[DISABLED][google.cloud.secretmanager.v1beta2.SecretVersion.State.DISABLED]. + +The async variant is +{@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::disableSecretVersionAsync()} . + + + + + + + + + + + + enableSecretVersion + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::enableSecretVersion() + + + request + + \Google\Cloud\SecretManager\V1beta2\EnableSecretVersionRequest + + + + callOptions + [] + array + + + + Enables a +[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. + Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of +the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to +[ENABLED][google.cloud.secretmanager.v1beta2.SecretVersion.State.ENABLED]. + +The async variant is +{@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::enableSecretVersionAsync()} . + + + + + + + + + + + + getIamPolicy + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getIamPolicy() + + + request + + \Google\Cloud\Iam\V1\GetIamPolicyRequest + + + + callOptions + [] + array + + + + Gets the access control policy for a secret. + Returns empty policy if the secret exists and does not have a policy set. + +The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getIamPolicyAsync()} . + + + + + + + + + + + + getSecret + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getSecret() + + + request + + \Google\Cloud\SecretManager\V1beta2\GetSecretRequest + + + + callOptions + [] + array + + + + Gets metadata for a given +[Secret][google.cloud.secretmanager.v1beta2.Secret]. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getSecretAsync()} . + + + + + + + + + + + + getSecretVersion + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getSecretVersion() + + + request + + \Google\Cloud\SecretManager\V1beta2\GetSecretVersionRequest + + + + callOptions + [] + array + + + + Gets metadata for a +[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. + `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the most recently +created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. + +The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getSecretVersionAsync()} +. + + + + + + + + + + + + listSecretVersions + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listSecretVersions() + + + request + + \Google\Cloud\SecretManager\V1beta2\ListSecretVersionsRequest + + + + callOptions + [] + array + + + + Lists [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion]. + This call does not return secret data. + +The async variant is +{@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listSecretVersionsAsync()} . + + + + + + + + + + + + listSecrets + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listSecrets() + + + request + + \Google\Cloud\SecretManager\V1beta2\ListSecretsRequest + + + + callOptions + [] + array + + + + Lists [Secrets][google.cloud.secretmanager.v1beta2.Secret]. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listSecretsAsync()} . + + + + + + + + + + + + setIamPolicy + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::setIamPolicy() + + + request + + \Google\Cloud\Iam\V1\SetIamPolicyRequest + + + + callOptions + [] + array + + + + Sets the access control policy on the specified secret. Replaces any +existing policy. + Permissions on +[SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] are +enforced according to the policy set on the associated +[Secret][google.cloud.secretmanager.v1beta2.Secret]. + +The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::setIamPolicyAsync()} . + + + + + + + + + + + + testIamPermissions + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::testIamPermissions() + + + request + + \Google\Cloud\Iam\V1\TestIamPermissionsRequest + + + + callOptions + [] + array + + + + Returns permissions that a caller has for the specified secret. + If the secret does not exist, this call returns an empty set of +permissions, not a NOT_FOUND error. + +Note: This operation is designed to be used for building permission-aware +UIs and command-line tools, not for authorization checking. This operation +may "fail open" without warning. + +The async variant is +{@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::testIamPermissionsAsync()} . + + + + + + + + + + + + updateSecret + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::updateSecret() + + + request + + \Google\Cloud\SecretManager\V1beta2\UpdateSecretRequest + + + + callOptions + [] + array + + + + Updates metadata of an existing +[Secret][google.cloud.secretmanager.v1beta2.Secret]. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::updateSecretAsync()} . + + + + + + + + + + + + getLocation + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getLocation() + + + request + + \Google\Cloud\Location\GetLocationRequest + + + + callOptions + [] + array + + + + Gets information about a location. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getLocationAsync()} . + + + + + + + + + + + + listLocations + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listLocations() + + + request + + \Google\Cloud\Location\ListLocationsRequest + + + + callOptions + [] + array + + + + Lists information about the supported locations for this service. + The async variant is {@see \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listLocationsAsync()} . + + + + + + + + + + + + accessSecretVersionAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::accessSecretVersionAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\AccessSecretVersionRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + addSecretVersionAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::addSecretVersionAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\AddSecretVersionRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + createSecretAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::createSecretAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\CreateSecretRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + deleteSecretAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::deleteSecretAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\DeleteSecretRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + destroySecretVersionAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::destroySecretVersionAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\DestroySecretVersionRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + disableSecretVersionAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::disableSecretVersionAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\DisableSecretVersionRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + enableSecretVersionAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::enableSecretVersionAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\EnableSecretVersionRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + getIamPolicyAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getIamPolicyAsync() + + + request + + \Google\Cloud\Iam\V1\GetIamPolicyRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + getSecretAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getSecretAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\GetSecretRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + getSecretVersionAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getSecretVersionAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\GetSecretVersionRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + listSecretVersionsAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listSecretVersionsAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\ListSecretVersionsRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + listSecretsAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listSecretsAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\ListSecretsRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + setIamPolicyAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::setIamPolicyAsync() + + + request + + \Google\Cloud\Iam\V1\SetIamPolicyRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + testIamPermissionsAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::testIamPermissionsAsync() + + + request + + \Google\Cloud\Iam\V1\TestIamPermissionsRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + updateSecretAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::updateSecretAsync() + + + request + + \Google\Cloud\SecretManager\V1beta2\UpdateSecretRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + getLocationAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::getLocationAsync() + + + request + + \Google\Cloud\Location\GetLocationRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + listLocationsAsync + \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient::listLocationsAsync() + + + request + + \Google\Cloud\Location\ListLocationsRequest + + + + optionalArgs + [] + array + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dev/tests/fixtures/phpdoc/structure.xml b/dev/tests/fixtures/phpdoc/structure.xml index 1b374d9b35e9..0b59072ee8f9 100644 --- a/dev/tests/fixtures/phpdoc/structure.xml +++ b/dev/tests/fixtures/phpdoc/structure.xml @@ -140,15 +140,15 @@ $hint = $hints[0]; ``` { - The bounding polygon of the recommended crop. - - Example: - ``` - $poly = $hint->boundingPoly(); - ``` - - @return array [BoundingPoly](https://cloud.google.com/vision/docs/reference/rest/v1/images/annotate#boundingpoly) -} +The bounding polygon of the recommended crop. { - Confidence of this being a salient region. Range [0, 1]. - - Example: - ``` - $confidence = $hint->confidence(); - ``` - - @return float -} +Confidence of this being a salient region. Range [0, 1]. { - Fraction of importance of this salient region with respect to the - original image. - - Example: - ``` - $importance = $hint->importanceFraction(); - ``` - - @return float -} +Fraction of importance of this salient region with respect to the +original image. { - Get the document pages. - - Example: - ``` - $pages = $document->pages(); - ``` - - @return array -} +Get the document pages. { - Get the document text. - - Example: - ``` - $text = $document->text(); - ``` - - @return string -} +Get the document text. Get the raw annotation result { - Get the Document Text detection result. - - Example: - ``` - $info = $document->info(); - ``` - - @return array -} +Get the Document Text detection result. { - Opaque entity ID. - - Some IDs might be available in Knowledge Graph(KG). - - Example: - ``` - echo $text->mid(); - ``` - - @see https://developers.google.com/knowledge-graph/ Knowledge Graph - - @return string -} +Opaque entity ID. { - The language code for the locale in which the entity textual description - (next field) is expressed. - - Example: - ``` - echo $text->locale(); - ``` - - @return string -} +The language code for the locale in which the entity textual description +(next field) is expressed. { - Entity textual description, expressed in its locale language. - - Example: - ``` - echo $text->description(); - ``` - - @return string -} +Entity textual description, expressed in its locale language. { - Overall score of the result. - - Range [0, 1]. - - Example: - ``` - echo $text->score(); - ``` - - @return float -} +Overall score of the result. { - The accuracy of the entity detection in an image. - - For example, for an image containing 'Eiffel Tower,' this field - represents the confidence that there is a tower in the query image. - - Range [0, 1]. - - Example: - ``` - echo $text->confidence(); - ``` - - @return float -} +The accuracy of the entity detection in an image. { - The relevancy of the ICA (Image Content Annotation) label to the image. - - For example, the relevancy of 'tower' to an image containing - 'Eiffel Tower' is likely higher than an image containing a distant - towering building, though the confidence that there is a tower may be the - same. - - Range [0, 1]. - - Example: - ``` - echo $text->topicality(); - ``` - - @return float -} +The relevancy of the ICA (Image Content Annotation) label to the image. { - Image region to which this entity belongs. - - Not filled currently for LABEL_DETECTION features. For TEXT_DETECTION - (OCR), boundingPolys are produced for the entire text detected in an - image region, followed by boundingPolys for each word within the detected - text. - - Example: - ``` - print_r($text->boundingPoly()); - ``` - - @return array -} +Image region to which this entity belongs. { - The location information for the detected entity. - - Multiple LocationInfo elements can be present since one location may - indicate the location of the scene in the query image, and another the - location of the place where the query image was taken. Location - information is usually present for landmarks. - - Example: - ``` - print_r($text->locations()); - ``` - - @return array -} +The location information for the detected entity. { - Some entities can have additional optional Property fields. For example a - different kind of score or string that qualifies the entity. - - Example: - ``` - print_r($text->properties()); - ``` - - @return array -} +Some entities can have additional optional Property fields. For example a +different kind of score or string that qualifies the entity. Get the raw annotation result { - Get the raw annotation result - - Example: - ``` - $info = $text->info(); - ``` - - @return array -} +Get the raw annotation result Get the raw annotation result { - Get the raw landmarks annotation result - - Example: - ``` - $info = $landmarks->info(); - ``` - - @return array -} +Get the raw landmarks annotation result - - likelihoodLevels - \Google\Cloud\Vision\Annotation\LikelihoodTrait::$likelihoodLevels - [\Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH => ['VERY_LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM => ['VERY_LIKELY', 'LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW => ['VERY_LIKELY', 'LIKELY', 'POSSIBLE']] - \Google\Cloud\Vision\Annotation\LikelihoodTrait + + info + \Google\Cloud\Vision\Annotation\AbstractFeature::$info + + \Google\Cloud\Vision\Annotation\AbstractFeature - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature + + likelihoodLevels + \Google\Cloud\Vision\Annotation\LikelihoodTrait::$likelihoodLevels + [\Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH => ['VERY_LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM => ['VERY_LIKELY', 'LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW => ['VERY_LIKELY', 'LIKELY', 'POSSIBLE']] + \Google\Cloud\Vision\Annotation\LikelihoodTrait - + + info + \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + \Google\Cloud\Vision\Annotation\AbstractFeature + Get the raw annotation result + Example: +``` +$info = $imageProperties->info(); +``` + + + + + + + likelihood \Google\Cloud\Vision\Annotation\LikelihoodTrait::likelihood() @@ -2052,28 +1910,6 @@ if ($face->hasHeadwear()) { type="bool"/> - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() - - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` - - - - @@ -2083,15 +1919,7 @@ $info = $imageProperties->info(); { - The bounding polygon around the face. - - Example: - ``` - print_r($face->boundingPoly()); - ``` - - @return array -} +The bounding polygon around the face. { - Bounding polygon around the face. - - Tighter than `boundingPoly` and encloses only the skin part of the face. - - Example: - ``` - print_r($face->fdBoundingPoly()); - ``` - - @return array -} +Bounding polygon around the face. { - Roll angle. - - Indicates the amount of clockwise/anti-clockwise rotation of the face. - Range [-180,180] - - Example: - ``` - print_r($face->rollAngle()); - ``` - - @return float -} +Roll angle. { - Yaw angle. - - Indicates the leftward/rightward angle that the face is pointing. Range - [-180,180] - - Example: - ``` - print_r($face->panAngle()); - ``` - - @return float -} +Yaw angle. { - Pitch angle. - - Indicates the upwards/downwards angle that the face is pointing. Range - [-180,180] - - Example: - ``` - print_r($face->tiltAngle()); - ``` - - @return float -} +Pitch angle. { - The detection confidence. - - Range [0,1] - - Example: - ``` - print_r($face->detectionConfidence()); - ``` - - @return float -} +The detection confidence. { - Face landmarking confidence. - - Range [0,1] - - Example: - ``` - print_r($face->landmarkingConfidence()); - ``` - - @return float -} +Face landmarking confidence. { - Joy likelihood. - - Example: - ``` - echo $face->joyLikelihood(); - ``` - - @return string -} +Joy likelihood. { - Sorrow likelihood. - - Example: - ``` - echo $face->sorrowLikelihood(); - ``` - - @return string -} +Sorrow likelihood. { - Anger likelihood. - - Example: - ``` - echo $face->angerLikelihood(); - ``` - - @return string -} +Anger likelihood. { - Surprise likelihood. - - Example: - ``` - echo $face->surpriseLikelihood(); - ``` - - @return string -} +Surprise likelihood. { - Under exposure likelihood. - - Example: - ``` - echo $face->underExposedLikelihood(); - ``` - - @return string -} +Under exposure likelihood. { - Blurred likelihood. - - Example: - ``` - echo $face->blurredLikelihood(); - ``` - - @return string -} +Blurred likelihood. { - Headwear likelihood. - - Example: - ``` - echo $face->headwearLikelihood(); - ``` - - @return string -} +Headwear likelihood. Get the raw annotation result { - Get the raw annotation result - - Example: - ``` - $info = $face->info(); - ``` - - @return array -} +Get the raw annotation result name="package" description="Application" /> - + STRENGTH_HIGH @@ -2507,7 +2208,7 @@ limitations under the License. - + @@ -2518,7 +2219,7 @@ limitations under the License. - + @@ -2529,7 +2230,7 @@ limitations under the License. - + @@ -2602,7 +2303,7 @@ $imageProperties = $annotation->imageProperties(); ``` Get the raw annotation result { - Get the raw annotation result - - Example: - ``` - $info = $imageProperties->info(); - ``` - - @return array -} +Get the raw annotation result name="package" description="Application" /> - + likelihoodLevels @@ -2882,27 +2575,27 @@ $safeSearch = $annotation->safeSearch(); ``` \Google\Cloud\Vision\Annotation\AbstractFeature - - likelihoodLevels - \Google\Cloud\Vision\Annotation\LikelihoodTrait::$likelihoodLevels - [\Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH => ['VERY_LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM => ['VERY_LIKELY', 'LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW => ['VERY_LIKELY', 'LIKELY', 'POSSIBLE']] - \Google\Cloud\Vision\Annotation\LikelihoodTrait + + info + \Google\Cloud\Vision\Annotation\AbstractFeature::$info + + \Google\Cloud\Vision\Annotation\AbstractFeature - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature + + likelihoodLevels + \Google\Cloud\Vision\Annotation\LikelihoodTrait::$likelihoodLevels + [\Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH => ['VERY_LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM => ['VERY_LIKELY', 'LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW => ['VERY_LIKELY', 'LIKELY', 'POSSIBLE']] + \Google\Cloud\Vision\Annotation\LikelihoodTrait - + + info + \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + \Google\Cloud\Vision\Annotation\AbstractFeature + Get the raw annotation result + Example: +``` +$info = $imageProperties->info(); +``` + + + + + + + likelihood \Google\Cloud\Vision\Annotation\LikelihoodTrait::likelihood() @@ -3158,28 +2873,6 @@ if ($safeSearch->isRacy()) { type="bool"/> - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() - - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` - - - - @@ -3189,15 +2882,7 @@ $info = $imageProperties->info(); { - Represents the adult contents likelihood for the image. - - Example: - ``` - echo $safeSearch->adult(); - ``` - - @return string -} +Represents the adult contents likelihood for the image. { - Spoof likelihood. The likelihood that an obvious modification was made to - the image's canonical version to make it appear funny or offensive. - - Example: - ``` - echo $safeSearch->spoof(); - ``` - - @return string -} +Spoof likelihood. The likelihood that an obvious modification was made to +the image's canonical version to make it appear funny or offensive. { - Likelihood this is a medical image. - - Example: - ``` - echo $safeSearch->medical(); - ``` - - @return string -} +Likelihood this is a medical image. { - Violence likelihood. - - Example: - ``` - echo $safeSearch->violence(); - ``` - - @return string -} +Violence likelihood. { - Racy likelihood. - - Example: - ``` - echo $safeSearch->racy(); - ``` - - @return string -} +Racy likelihood. Get the raw annotation result { - Get the raw annotation result - - Example: - ``` - $info = $safeSearch->info(); - ``` - - @return array -} +Get the raw annotation result { - The Entity ID - - Example: - ``` - $id = $entity->entityId(); - ``` - - @return string -} +The Entity ID { - Overall relevancy score for the image. - - Not normalized and not comparable across different image queries. - - Example: - ``` - $score = $entity->score(); - ``` - - @return float -} +Overall relevancy score for the image. { - Canonical description of the entity, in English. - - Example: - ``` - $description = $entity->description(); - ``` - - @return string -} +Canonical description of the entity, in English. { - The result image URL - - Example: - ``` - $url = $image->url(); - ``` - - @return string -} +The result image URL { - Overall relevancy score for the image. - - Not normalized and not comparable across different image queries. - - Example: - ``` - $score = $image->score(); - ``` - - @return float -} +Overall relevancy score for the image. { - The result web page URL - - Example: - ``` - $url = $image->url(); - ``` - - @return string -} +The result web page URL { - Overall relevancy score for the image. - - Not normalized and not comparable across different image queries. - - Example: - ``` - $score = $image->score(); - ``` - - @return float -} +Overall relevancy score for the image. name="package" description="Application" /> - + annotate @@ -4870,7 +4453,7 @@ limitations under the License. - + @@ -5097,7 +4680,7 @@ $image = new Image($imageResource, [ - + @@ -5108,7 +4691,7 @@ $image = new Image($imageResource, [ - + @@ -5119,7 +4702,7 @@ $image = new Image($imageResource, [ - + @@ -7970,7 +7553,7 @@ comes from. - + @@ -8032,20 +7615,36 @@ Example: `projects/project-A/locations/eu`. Generated from protobuf field <code>string parent = 4;</code> + + + + labels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::$labels + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + - + build \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::build() - + requests \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] - + - + __construct \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::__construct() - + data NULL array - + Constructor. - + getRequests \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getRequests() - + Required. Individual async file annotation requests for this batch. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + setRequests \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setRequests() - + var \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[]|\Google\Protobuf\Internal\RepeatedField - + Required. Individual async file annotation requests for this batch. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + getParent \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getParent() - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -8148,17 +7747,17 @@ Generated from protobuf field <code>string parent = 4;</code> - + setParent \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setParent() - + var string - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -8179,6 +7778,56 @@ Generated from protobuf field <code>string parent = 4;</code> + + + + getLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getLabels() + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + + + + setLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setLabels() + + + var + + array|\Google\Protobuf\Internal\MapField + + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + @@ -8302,7 +7951,7 @@ AsyncBatchAnnotateFilesRequest. - + @@ -8374,26 +8023,42 @@ Example: `projects/project-A/locations/eu`. Generated from protobuf field <code>string parent = 4;</code> + + + + labels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$labels + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + - + build \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::build() - + requests \Google\Cloud\Vision\V1\AnnotateImageRequest[] - + outputConfig \Google\Cloud\Vision\V1\OutputConfig - + - + __construct \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::__construct() - + data NULL array - + Constructor. - + getRequests \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getRequests() - + Required. Individual image annotation requests for this batch. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + setRequests \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setRequests() - + var \Google\Cloud\Vision\V1\AnnotateImageRequest[]|\Google\Protobuf\Internal\RepeatedField - + Required. Individual image annotation requests for this batch. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + getOutputConfig \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getOutputConfig() - + Required. The desired output location and metadata (e.g. format). Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> - + hasOutputConfig \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::hasOutputConfig() - + - + clearOutputConfig \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::clearOutputConfig() - + - + setOutputConfig \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setOutputConfig() - + var \Google\Cloud\Vision\V1\OutputConfig - + Required. The desired output location and metadata (e.g. format). Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> - + getParent \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getParent() - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -8562,17 +8227,17 @@ Generated from protobuf field <code>string parent = 4;</code> - + setParent \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setParent() - + var string - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -8593,6 +8258,56 @@ Generated from protobuf field <code>string parent = 4;</code> + + + + getLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getLabels() + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + + + + setLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setLabels() + + + var + + array|\Google\Protobuf\Internal\MapField + + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + @@ -8735,7 +8450,7 @@ Generated from protobuf field <code>string parent = 4;</code> - + @@ -8773,8 +8488,8 @@ Generated from protobuf field <code>string parent = 4;</code>\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$requests - Required. The list of file annotation requests. Right now we support only one -AnnotateFileRequest in BatchAnnotateFilesRequest. + Required. The list of file annotation requests. Right now we support only +one AnnotateFileRequest in BatchAnnotateFilesRequest. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> @@ -8797,25 +8512,41 @@ Example: `projects/project-A/locations/eu`. Generated from protobuf field <code>string parent = 3;</code> + + + + labels + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$labels + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + - + build \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::build() - + requests \Google\Cloud\Vision\V1\AnnotateFileRequest[] - + - + __construct \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::__construct() - + data NULL array - + Constructor. - + getRequests \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getRequests() - - Required. The list of file annotation requests. Right now we support only one -AnnotateFileRequest in BatchAnnotateFilesRequest. + + Required. The list of file annotation requests. Right now we support only +one AnnotateFileRequest in BatchAnnotateFilesRequest. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + setRequests \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setRequests() - + var \Google\Cloud\Vision\V1\AnnotateFileRequest[]|\Google\Protobuf\Internal\RepeatedField - - Required. The list of file annotation requests. Right now we support only one -AnnotateFileRequest in BatchAnnotateFilesRequest. + + Required. The list of file annotation requests. Right now we support only +one AnnotateFileRequest in BatchAnnotateFilesRequest. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + getParent \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getParent() - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -8915,17 +8646,17 @@ Generated from protobuf field <code>string parent = 3;</code> - + setParent \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setParent() - + var string - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -8946,6 +8677,56 @@ Generated from protobuf field <code>string parent = 3;</code> + + + + getLabels + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getLabels() + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + + + + setLabels + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setLabels() + + + var + + array|\Google\Protobuf\Internal\MapField + + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + @@ -9069,7 +8850,7 @@ AnnotateFileRequest in BatchAnnotateFilesRequest. - + @@ -9130,20 +8911,36 @@ Example: `projects/project-A/locations/eu`. Generated from protobuf field <code>string parent = 4;</code> + + + + labels + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::$labels + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + - + build \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::build() - + requests \Google\Cloud\Vision\V1\AnnotateImageRequest[] - + - + __construct \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::__construct() - + data NULL array - + Constructor. - + getRequests \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getRequests() - + Required. Individual image annotation requests for this batch. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + setRequests \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setRequests() - + var \Google\Cloud\Vision\V1\AnnotateImageRequest[]|\Google\Protobuf\Internal\RepeatedField - + Required. Individual image annotation requests for this batch. Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + getParent \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getParent() - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -9246,17 +9043,17 @@ Generated from protobuf field <code>string parent = 4;</code> - + setParent \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setParent() - + var string - + Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. @@ -9277,6 +9074,56 @@ Generated from protobuf field <code>string parent = 4;</code> + + + + getLabels + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getLabels() + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + + + + setLabels + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setLabels() + + + var + + array|\Google\Protobuf\Internal\MapField + + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + @@ -9436,7 +9283,7 @@ Generated from protobuf field <code>string parent = 4;</code> Invalid. Generated from protobuf enum <code>STATE_UNSPECIFIED = 0;</code> - + @@ -9447,7 +9294,7 @@ Generated from protobuf field <code>string parent = 4;</code> Request is actively being processed. Generated from protobuf enum <code>PROCESSING = 1;</code> - + @@ -9459,7 +9306,7 @@ Generated from protobuf field <code>string parent = 4;</code>The request is done and at least one item has been successfully processed. Generated from protobuf enum <code>SUCCESSFUL = 2;</code> - + @@ -9470,7 +9317,7 @@ processed. The request is done and no item has been successfully processed. Generated from protobuf enum <code>FAILED = 3;</code> - + @@ -9483,7 +9330,7 @@ processed. been called by the user. Any records that were processed before the cancel command are output as specified in the request. Generated from protobuf enum <code>CANCELLED = 4;</code> - + @@ -9540,7 +9387,7 @@ cancel command are output as specified in the request. - + @@ -9598,45 +9445,46 @@ Generated from protobuf message <code>google.cloud.vision.v1.BatchOperatio - + end_time \Google\Cloud\Vision\V1\BatchOperationMetadata::$end_time null - + The time when the batch request is finished and -[google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true. +[google.longrunning.Operation.done][google.longrunning.Operation.done] is +set to true. Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> - + __construct \Google\Cloud\Vision\V1\BatchOperationMetadata::__construct() - + data NULL array - + Constructor. - + getState \Google\Cloud\Vision\V1\BatchOperationMetadata::getState() - + The current state of the batch operation. Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> - + setState \Google\Cloud\Vision\V1\BatchOperationMetadata::setState() - + var int - + The current state of the batch operation. Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> - + getSubmitTime \Google\Cloud\Vision\V1\BatchOperationMetadata::getSubmitTime() - + The time when the batch request was submitted to the server. Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> - + hasSubmitTime \Google\Cloud\Vision\V1\BatchOperationMetadata::hasSubmitTime() - + - + clearSubmitTime \Google\Cloud\Vision\V1\BatchOperationMetadata::clearSubmitTime() - + - + setSubmitTime \Google\Cloud\Vision\V1\BatchOperationMetadata::setSubmitTime() - + var \Google\Protobuf\Timestamp - + The time when the batch request was submitted to the server. Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> - + getEndTime \Google\Cloud\Vision\V1\BatchOperationMetadata::getEndTime() - + The time when the batch request is finished and -[google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true. +[google.longrunning.Operation.done][google.longrunning.Operation.done] is +set to true. Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> - + hasEndTime \Google\Cloud\Vision\V1\BatchOperationMetadata::hasEndTime() - + - + clearEndTime \Google\Cloud\Vision\V1\BatchOperationMetadata::clearEndTime() - + - + setEndTime \Google\Cloud\Vision\V1\BatchOperationMetadata::setEndTime() - + var \Google\Protobuf\Timestamp - + The time when the batch request is finished and -[google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true. +[google.longrunning.Operation.done][google.longrunning.Operation.done] is +set to true. Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> Unknown block type. Generated from protobuf enum <code>UNKNOWN = 0;</code> - + @@ -9898,7 +9748,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.BatchOperatio Regular text block. Generated from protobuf enum <code>TEXT = 1;</code> - + @@ -9909,7 +9759,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.BatchOperatio Table block. Generated from protobuf enum <code>TABLE = 2;</code> - + @@ -9920,7 +9770,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.BatchOperatio Image block. Generated from protobuf enum <code>PICTURE = 3;</code> - + @@ -9931,7 +9781,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.BatchOperatio Horizontal/vertical line box. Generated from protobuf enum <code>RULER = 4;</code> - + @@ -9942,7 +9792,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.BatchOperatio Barcode block. Generated from protobuf enum <code>BARCODE = 5;</code> - + @@ -10118,7 +9968,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b @@ -10611,7 +10461,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + @@ -10629,10 +10479,10 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + ImageAnnotatorClient \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient - + Service Description: Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images. @@ -10642,14 +10492,8 @@ calls that map to API methods. Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - -This class is currently experimental and may be subject to changes. See {@see \Google\Cloud\Vision\V1\ImageAnnotatorClient} for the stable implementation +contained within formatted names that are returned by the API. - @@ -10673,67 +10517,82 @@ This class is currently experimental and may be subject to changes. See {@see \G - + SERVICE_NAME \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_NAME 'google.cloud.vision.v1.ImageAnnotator' - + The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_ADDRESS 'vision.googleapis.com' - + The default address of the service. - + + - + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + + The address template of the service. + + + + + + DEFAULT_SERVICE_PORT \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::DEFAULT_SERVICE_PORT 443 - + The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::CODEGEN_NAME 'gapic' - + The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - + The default scopes required by the service. - + operationsClient \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::$operationsClient - + @@ -10741,22 +10600,22 @@ This class is currently experimental and may be subject to changes. See {@see \G - + getClientDefaults \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getClientDefaults() - + - + getOperationsClient \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getOperationsClient() - + Return an OperationsClient object with the same endpoint as $this. - + resumeOperation \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::resumeOperation() - + operationName string - + methodName null string - + Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the @@ -10805,29 +10664,29 @@ OperationResponse object will not deserialize the final response. - + productSetName \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::productSetName() - + project string - + location string - + productSet string - + Formats a string containing the fully-qualified path to represent a product_set resource. @@ -10851,23 +10710,23 @@ resource. - + parseName \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::parseName() - + formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -10898,17 +10757,17 @@ the first match. - + __construct \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::__construct() - + options [] array - + Constructor. - + __call \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::__call() - + method mixed - + args mixed - + Handles execution of the async variants for each documented method. - + asyncBatchAnnotateFiles \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFiles() - + request \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest - + callOptions [] array - + Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the @@ -10973,6 +10832,10 @@ images per page. Progress and results can be retrieved through the The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFilesAsync()} . + @@ -10992,23 +10855,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - + asyncBatchAnnotateImages \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImages() - + request \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest - + callOptions [] array - + Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. @@ -11021,6 +10884,10 @@ GCS bucket, each json file containing BatchAnnotateImagesResponse proto. The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImagesAsync()} . + @@ -11040,23 +10907,23 @@ The async variant is - + batchAnnotateFiles \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFiles() - + request \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest - + callOptions [] array - + Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. @@ -11067,6 +10934,10 @@ extracted. The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFilesAsync()} . + @@ -11086,26 +10957,30 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - + batchAnnotateImages \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImages() - + request \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest - + callOptions [] array - + Run image detection and annotation for a batch of images. The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImagesAsync()} . + @@ -11136,8 +11011,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - optionalArgs = [] - + optionalArgs + [] array @@ -11147,7 +11022,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\OperationResponse>"/> @@ -11163,8 +11038,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - optionalArgs = [] - + optionalArgs + [] array @@ -11174,7 +11049,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\OperationResponse>"/> @@ -11190,8 +11065,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - optionalArgs = [] - + optionalArgs + [] array @@ -11201,7 +11076,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\BatchAnnotateFilesResponse>"/> @@ -11217,8 +11092,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - optionalArgs = [] - + optionalArgs + [] array @@ -11228,7 +11103,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\BatchAnnotateImagesResponse>"/> @@ -11239,7 +11114,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - + @@ -11257,22 +11132,24 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient:: - + ProductSearchClient \Google\Cloud\Vision\V1\Client\ProductSearchClient - + Service Description: Manages Products and ProductSets of reference images for use in product search. It uses the following resource model: - - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] resources, named -`projects/&#42;/locations/&#42;/productSets/*`, which acts as a way to put different -products into groups to limit identification. + - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] +resources, named `projects/&#42;/locations/&#42;/productSets/*`, which acts as a way +to put different products into groups to limit identification. In parallel, -- The API has a collection of [Product][google.cloud.vision.v1.Product] resources, named +- The API has a collection of [Product][google.cloud.vision.v1.Product] +resources, named `projects/&#42;/locations/&#42;/products/*` -- Each [Product][google.cloud.vision.v1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named +- Each [Product][google.cloud.vision.v1.Product] has a collection of +[ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named `projects/&#42;/locations/&#42;/products/&#42;/referenceImages/*` This class provides the ability to make remote calls to the backing service through method @@ -11281,14 +11158,8 @@ calls that map to API methods. Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - -This class is currently experimental and may be subject to changes. See {@see \Google\Cloud\Vision\V1\ProductSearchClient} for the stable implementation +contained within formatted names that are returned by the API. - @@ -11372,67 +11243,82 @@ This class is currently experimental and may be subject to changes. See {@see \G - + SERVICE_NAME \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_NAME 'google.cloud.vision.v1.ProductSearch' - + The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_ADDRESS 'vision.googleapis.com' - + The default address of the service. - + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + + The address template of the service. + + - + DEFAULT_SERVICE_PORT \Google\Cloud\Vision\V1\Client\ProductSearchClient::DEFAULT_SERVICE_PORT 443 - + The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\Vision\V1\Client\ProductSearchClient::CODEGEN_NAME 'gapic' - + The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\Vision\V1\Client\ProductSearchClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - + The default scopes required by the service. - + operationsClient \Google\Cloud\Vision\V1\Client\ProductSearchClient::$operationsClient - + @@ -11440,22 +11326,22 @@ This class is currently experimental and may be subject to changes. See {@see \G - + getClientDefaults \Google\Cloud\Vision\V1\Client\ProductSearchClient::getClientDefaults() - + - + getOperationsClient \Google\Cloud\Vision\V1\Client\ProductSearchClient::getOperationsClient() - + Return an OperationsClient object with the same endpoint as $this. - + resumeOperation \Google\Cloud\Vision\V1\Client\ProductSearchClient::resumeOperation() - + operationName string - + methodName null string - + Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the @@ -11504,23 +11390,23 @@ OperationResponse object will not deserialize the final response. - + locationName \Google\Cloud\Vision\V1\Client\ProductSearchClient::locationName() - + project string - + location string - + Formats a string containing the fully-qualified path to represent a location resource. @@ -11540,29 +11426,29 @@ resource. - + productName \Google\Cloud\Vision\V1\Client\ProductSearchClient::productName() - + project string - + location string - + product string - + Formats a string containing the fully-qualified path to represent a product resource. @@ -11586,29 +11472,29 @@ resource. - + productSetName \Google\Cloud\Vision\V1\Client\ProductSearchClient::productSetName() - + project string - + location string - + productSet string - + Formats a string containing the fully-qualified path to represent a product_set resource. @@ -11632,35 +11518,35 @@ resource. - + referenceImageName \Google\Cloud\Vision\V1\Client\ProductSearchClient::referenceImageName() - + project string - + location string - + product string - + referenceImage string - + Formats a string containing the fully-qualified path to represent a reference_image resource. @@ -11688,23 +11574,23 @@ reference_image resource. - + parseName \Google\Cloud\Vision\V1\Client\ProductSearchClient::parseName() - + formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -11738,17 +11624,17 @@ the first match. - + __construct \Google\Cloud\Vision\V1\Client\ProductSearchClient::__construct() - + options [] array - + Constructor. - + __call \Google\Cloud\Vision\V1\Client\ProductSearchClient::__call() - + method mixed - + args mixed - + Handles execution of the async variants for each documented method. - + addProductToProductSet \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSet() - + request \Google\Cloud\Vision\V1\AddProductToProductSetRequest - + callOptions [] array - + Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. @@ -11813,6 +11699,10 @@ Possible errors: The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSetAsync()} . + @@ -11828,23 +11718,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::a - + createProduct \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProduct() - + request \Google\Cloud\Vision\V1\CreateProductRequest - + callOptions [] array - + Creates and returns a new product resource. Possible errors: @@ -11855,6 +11745,10 @@ characters. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductAsync()} . + @@ -11874,23 +11768,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::c - + createProductSet \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSet() - + request \Google\Cloud\Vision\V1\CreateProductSetRequest - + callOptions [] array - + Creates and returns a new ProductSet resource. Possible errors: @@ -11899,6 +11793,10 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::c The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSetAsync()} . + @@ -11918,23 +11816,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::c - + createReferenceImage \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImage() - + request \Google\Cloud\Vision\V1\CreateReferenceImageRequest - + callOptions [] array - + Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are @@ -11956,6 +11854,10 @@ compatible with the parent product's product_category is detected. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImageAsync()} . + @@ -11975,23 +11877,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::c - + deleteProduct \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProduct() - + request \Google\Cloud\Vision\V1\DeleteProductRequest - + callOptions [] array - + Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work @@ -11999,6 +11901,10 @@ until all related caches are refreshed. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductAsync()} . + @@ -12014,29 +11920,33 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::d - + deleteProductSet \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSet() - + request \Google\Cloud\Vision\V1\DeleteProductSetRequest - + callOptions [] array - + Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSetAsync()} . + @@ -12052,23 +11962,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::d - + deleteReferenceImage \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImage() - + request \Google\Cloud\Vision\V1\DeleteReferenceImageRequest - + callOptions [] array - + Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related @@ -12078,6 +11988,10 @@ The actual image files are not deleted from Google Cloud Storage. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImageAsync()} . + @@ -12093,23 +12007,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::d - + getProduct \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProduct() - + request \Google\Cloud\Vision\V1\GetProductRequest - + callOptions [] array - + Gets information associated with a Product. Possible errors: @@ -12117,6 +12031,10 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::d The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductAsync()} . + @@ -12136,23 +12054,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::g - + getProductSet \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSet() - + request \Google\Cloud\Vision\V1\GetProductSetRequest - + callOptions [] array - + Gets information associated with a ProductSet. Possible errors: @@ -12160,6 +12078,10 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::g The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSetAsync()} . + @@ -12179,23 +12101,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::g - + getReferenceImage \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImage() - + request \Google\Cloud\Vision\V1\GetReferenceImageRequest - + callOptions [] array - + Gets information associated with a ReferenceImage. Possible errors: @@ -12203,6 +12125,10 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::g The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImageAsync()} . + @@ -12222,27 +12148,27 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::g - + importProductSets \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSets() - + request \Google\Cloud\Vision\V1\ImportProductSetsRequest - + callOptions [] array - + Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. - The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. + The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) @@ -12252,6 +12178,10 @@ For the format of the csv file please see The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSetsAsync()} . + @@ -12271,23 +12201,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::i - + listProductSets \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSets() - + request \Google\Cloud\Vision\V1\ListProductSetsRequest - + callOptions [] array - + Lists ProductSets in an unspecified order. Possible errors: @@ -12296,6 +12226,10 @@ than 1. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSetsAsync()} . + @@ -12315,23 +12249,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::l - + listProducts \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProducts() - + request \Google\Cloud\Vision\V1\ListProductsRequest - + callOptions [] array - + Lists products in an unspecified order. Possible errors: @@ -12339,6 +12273,10 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::l The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsAsync()} . + @@ -12358,23 +12296,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::l - + listProductsInProductSet \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSet() - + request \Google\Cloud\Vision\V1\ListProductsInProductSetRequest - + callOptions [] array - + Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. @@ -12385,6 +12323,10 @@ empty. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSetAsync()} . + @@ -12404,23 +12346,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::l - + listReferenceImages \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImages() - + request \Google\Cloud\Vision\V1\ListReferenceImagesRequest - + callOptions [] array - + Lists reference images. Possible errors: @@ -12430,6 +12372,10 @@ than 1. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImagesAsync()} . + @@ -12449,23 +12395,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::l - + purgeProducts \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProducts() - + request \Google\Cloud\Vision\V1\PurgeProductsRequest - + callOptions [] array - + Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other @@ -12486,12 +12432,16 @@ re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. -The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. +The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync()} . + @@ -12511,27 +12461,31 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::p - + removeProductFromProductSet \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSet() - + request \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest - + callOptions [] array - + Removes a Product from the specified ProductSet. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSetAsync()} . + @@ -12547,23 +12501,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::p - + updateProduct \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProduct() - + request \Google\Cloud\Vision\V1\UpdateProductRequest - + callOptions [] array - + Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. @@ -12582,6 +12536,10 @@ longer than 4096 characters. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductAsync()} . + @@ -12601,23 +12559,23 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - + updateProductSet \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSet() - + request \Google\Cloud\Vision\V1\UpdateProductSetRequest - + callOptions [] array - + Makes changes to a ProductSet resource. Only display_name can be updated currently. @@ -12629,6 +12587,10 @@ missing from the request or longer than 4096 characters. The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSetAsync()} . + @@ -12659,8 +12621,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12670,7 +12632,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> @@ -12686,8 +12648,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12697,7 +12659,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\Product>"/> @@ -12713,8 +12675,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12724,7 +12686,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ProductSet>"/> @@ -12740,8 +12702,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12751,7 +12713,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ReferenceImage>"/> @@ -12767,8 +12729,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12778,7 +12740,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> @@ -12794,8 +12756,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12805,7 +12767,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> @@ -12821,8 +12783,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12832,7 +12794,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> @@ -12848,8 +12810,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12859,7 +12821,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\Product>"/> @@ -12875,8 +12837,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12886,7 +12848,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ProductSet>"/> @@ -12902,8 +12864,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12913,7 +12875,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ReferenceImage>"/> @@ -12929,8 +12891,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12940,7 +12902,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\OperationResponse>"/> @@ -12956,8 +12918,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12967,7 +12929,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\PagedListResponse>"/> @@ -12983,8 +12945,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -12994,7 +12956,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\PagedListResponse>"/> @@ -13010,8 +12972,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -13021,7 +12983,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\PagedListResponse>"/> @@ -13037,8 +12999,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -13048,7 +13010,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\PagedListResponse>"/> @@ -13064,8 +13026,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -13075,7 +13037,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\OperationResponse>"/> @@ -13091,8 +13053,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -13102,7 +13064,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> @@ -13118,8 +13080,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -13129,7 +13091,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\Product>"/> @@ -13145,8 +13107,8 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u - optionalArgs = [] - + optionalArgs + [] array @@ -13156,7 +13118,7 @@ The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::u + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ProductSet>"/> @@ -14013,7 +13975,7 @@ long. It cannot contain the character `/`. - + @@ -14046,12 +14008,13 @@ long. It cannot contain the character `/`. \Google\Protobuf\Internal\Message - + parent \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$parent '' - - Required. Resource name of the product in which to create the reference image. + + Required. Resource name of the product in which to create the reference +image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @@ -14060,11 +14023,11 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - + reference_image \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$reference_image null - + Required. The reference image to create. If an image ID is specified, it is ignored. @@ -14073,11 +14036,11 @@ Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage - + reference_image_id \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$reference_image_id '' - + A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at @@ -14088,34 +14051,34 @@ most 128 characters long. It cannot contain the character `/`. - + build \Google\Cloud\Vision\V1\CreateReferenceImageRequest::build() - + parent string - + referenceImage \Google\Cloud\Vision\V1\ReferenceImage - + referenceImageId string - + - + __construct \Google\Cloud\Vision\V1\CreateReferenceImageRequest::__construct() - + data NULL array - + Constructor. - + getParent \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getParent() - - Required. Resource name of the product in which to create the reference image. + + Required. Resource name of the product in which to create the reference +image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @@ -14176,18 +14140,19 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - + setParent \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setParent() - + var string - - Required. Resource name of the product in which to create the reference image. + + Required. Resource name of the product in which to create the reference +image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @@ -14204,11 +14169,11 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - + getReferenceImage \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getReferenceImage() - + Required. The reference image to create. If an image ID is specified, it is ignored. @@ -14221,39 +14186,39 @@ Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage - + hasReferenceImage \Google\Cloud\Vision\V1\CreateReferenceImageRequest::hasReferenceImage() - + - + clearReferenceImage \Google\Cloud\Vision\V1\CreateReferenceImageRequest::clearReferenceImage() - + - + setReferenceImage \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setReferenceImage() - + var \Google\Cloud\Vision\V1\ReferenceImage - + Required. The reference image to create. If an image ID is specified, it is ignored. @@ -14270,11 +14235,11 @@ Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage - + getReferenceImageId \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getReferenceImageId() - + A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at @@ -14288,17 +14253,17 @@ most 128 characters long. It cannot contain the character `/`. - + setReferenceImageId \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setReferenceImageId() - + var string - + A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at @@ -16019,7 +15984,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Unknown face landmark detected. Should not be filled. Generated from protobuf enum <code>UNKNOWN_LANDMARK = 0;</code> - + @@ -16030,7 +15995,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left eye. Generated from protobuf enum <code>LEFT_EYE = 1;</code> - + @@ -16041,7 +16006,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right eye. Generated from protobuf enum <code>RIGHT_EYE = 2;</code> - + @@ -16052,7 +16017,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left of left eyebrow. Generated from protobuf enum <code>LEFT_OF_LEFT_EYEBROW = 3;</code> - + @@ -16063,7 +16028,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right of left eyebrow. Generated from protobuf enum <code>RIGHT_OF_LEFT_EYEBROW = 4;</code> - + @@ -16074,7 +16039,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left of right eyebrow. Generated from protobuf enum <code>LEFT_OF_RIGHT_EYEBROW = 5;</code> - + @@ -16085,7 +16050,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right of right eyebrow. Generated from protobuf enum <code>RIGHT_OF_RIGHT_EYEBROW = 6;</code> - + @@ -16096,7 +16061,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Midpoint between eyes. Generated from protobuf enum <code>MIDPOINT_BETWEEN_EYES = 7;</code> - + @@ -16107,7 +16072,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Nose tip. Generated from protobuf enum <code>NOSE_TIP = 8;</code> - + @@ -16118,7 +16083,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Upper lip. Generated from protobuf enum <code>UPPER_LIP = 9;</code> - + @@ -16129,7 +16094,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Lower lip. Generated from protobuf enum <code>LOWER_LIP = 10;</code> - + @@ -16140,7 +16105,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Mouth left. Generated from protobuf enum <code>MOUTH_LEFT = 11;</code> - + @@ -16151,7 +16116,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Mouth right. Generated from protobuf enum <code>MOUTH_RIGHT = 12;</code> - + @@ -16162,7 +16127,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Mouth center. Generated from protobuf enum <code>MOUTH_CENTER = 13;</code> - + @@ -16173,7 +16138,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Nose, bottom right. Generated from protobuf enum <code>NOSE_BOTTOM_RIGHT = 14;</code> - + @@ -16184,7 +16149,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Nose, bottom left. Generated from protobuf enum <code>NOSE_BOTTOM_LEFT = 15;</code> - + @@ -16195,7 +16160,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Nose, bottom center. Generated from protobuf enum <code>NOSE_BOTTOM_CENTER = 16;</code> - + @@ -16206,7 +16171,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left eye, top boundary. Generated from protobuf enum <code>LEFT_EYE_TOP_BOUNDARY = 17;</code> - + @@ -16217,7 +16182,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left eye, right corner. Generated from protobuf enum <code>LEFT_EYE_RIGHT_CORNER = 18;</code> - + @@ -16228,7 +16193,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left eye, bottom boundary. Generated from protobuf enum <code>LEFT_EYE_BOTTOM_BOUNDARY = 19;</code> - + @@ -16239,7 +16204,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left eye, left corner. Generated from protobuf enum <code>LEFT_EYE_LEFT_CORNER = 20;</code> - + @@ -16250,7 +16215,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right eye, top boundary. Generated from protobuf enum <code>RIGHT_EYE_TOP_BOUNDARY = 21;</code> - + @@ -16261,7 +16226,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right eye, right corner. Generated from protobuf enum <code>RIGHT_EYE_RIGHT_CORNER = 22;</code> - + @@ -16272,7 +16237,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right eye, bottom boundary. Generated from protobuf enum <code>RIGHT_EYE_BOTTOM_BOUNDARY = 23;</code> - + @@ -16283,7 +16248,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right eye, left corner. Generated from protobuf enum <code>RIGHT_EYE_LEFT_CORNER = 24;</code> - + @@ -16294,7 +16259,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left eyebrow, upper midpoint. Generated from protobuf enum <code>LEFT_EYEBROW_UPPER_MIDPOINT = 25;</code> - + @@ -16305,7 +16270,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right eyebrow, upper midpoint. Generated from protobuf enum <code>RIGHT_EYEBROW_UPPER_MIDPOINT = 26;</code> - + @@ -16316,7 +16281,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left ear tragion. Generated from protobuf enum <code>LEFT_EAR_TRAGION = 27;</code> - + @@ -16327,7 +16292,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right ear tragion. Generated from protobuf enum <code>RIGHT_EAR_TRAGION = 28;</code> - + @@ -16338,7 +16303,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left eye pupil. Generated from protobuf enum <code>LEFT_EYE_PUPIL = 29;</code> - + @@ -16349,7 +16314,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right eye pupil. Generated from protobuf enum <code>RIGHT_EYE_PUPIL = 30;</code> - + @@ -16360,7 +16325,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Forehead glabella. Generated from protobuf enum <code>FOREHEAD_GLABELLA = 31;</code> - + @@ -16371,7 +16336,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Chin gnathion. Generated from protobuf enum <code>CHIN_GNATHION = 32;</code> - + @@ -16382,7 +16347,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Chin left gonion. Generated from protobuf enum <code>CHIN_LEFT_GONION = 33;</code> - + @@ -16393,7 +16358,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Chin right gonion. Generated from protobuf enum <code>CHIN_RIGHT_GONION = 34;</code> - + @@ -16404,7 +16369,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Left cheek center. Generated from protobuf enum <code>LEFT_CHEEK_CENTER = 35;</code> - + @@ -16415,7 +16380,7 @@ Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type< Right cheek center. Generated from protobuf enum <code>RIGHT_CHEEK_CENTER = 36;</code> - + @@ -17705,7 +17670,7 @@ pointing relative to the image's horizontal plane. Range [-180,180]. Unspecified feature type. Generated from protobuf enum <code>TYPE_UNSPECIFIED = 0;</code> - + @@ -17716,7 +17681,7 @@ pointing relative to the image's horizontal plane. Range [-180,180]. Run face detection. Generated from protobuf enum <code>FACE_DETECTION = 1;</code> - + @@ -17727,7 +17692,7 @@ pointing relative to the image's horizontal plane. Range [-180,180]. Run landmark detection. Generated from protobuf enum <code>LANDMARK_DETECTION = 2;</code> - + @@ -17738,7 +17703,7 @@ pointing relative to the image's horizontal plane. Range [-180,180]. Run logo detection. Generated from protobuf enum <code>LOGO_DETECTION = 3;</code> - + @@ -17749,7 +17714,7 @@ pointing relative to the image's horizontal plane. Range [-180,180]. Run label detection. Generated from protobuf enum <code>LABEL_DETECTION = 4;</code> - + @@ -17762,7 +17727,7 @@ pointing relative to the image's horizontal plane. Range [-180,180]. Generated from protobuf enum <code>TEXT_DETECTION = 5;</code> - + @@ -17774,7 +17739,7 @@ a document, use `DOCUMENT_TEXT_DETECTION` instead. Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present. Generated from protobuf enum <code>DOCUMENT_TEXT_DETECTION = 11;</code> - + @@ -17786,7 +17751,7 @@ a document, use `DOCUMENT_TEXT_DETECTION` instead. Run Safe Search to detect potentially unsafe or undesirable content. Generated from protobuf enum <code>SAFE_SEARCH_DETECTION = 6;</code> - + @@ -17798,7 +17763,7 @@ or undesirable content. Compute a set of image properties, such as the image's dominant colors. Generated from protobuf enum <code>IMAGE_PROPERTIES = 7;</code> - + @@ -17809,7 +17774,7 @@ image's dominant colors. Run crop hints. Generated from protobuf enum <code>CROP_HINTS = 9;</code> - + @@ -17820,7 +17785,7 @@ image's dominant colors. Run web detection. Generated from protobuf enum <code>WEB_DETECTION = 10;</code> - + @@ -17831,7 +17796,7 @@ image's dominant colors. Run Product Search. Generated from protobuf enum <code>PRODUCT_SEARCH = 12;</code> - + @@ -17842,7 +17807,7 @@ image's dominant colors. Run localizer for object detection. Generated from protobuf enum <code>OBJECT_LOCALIZATION = 19;</code> - + @@ -18174,7 +18139,7 @@ Generated from protobuf field <code>string model = 3;</code> - + @@ -18192,10 +18157,10 @@ Generated from protobuf field <code>string model = 3;</code> + ImageAnnotatorGapicClient \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - + Service Description: Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images. @@ -18240,10 +18205,12 @@ try { Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - -This service has a new (beta) implementation. See {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient} to use the new surface. +contained within formatted names that are returned by the API. + @@ -18251,89 +18218,104 @@ This service has a new (beta) implementation. See {@see \Google\Cloud\Vision\V1\ - + SERVICE_NAME \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_NAME 'google.cloud.vision.v1.ImageAnnotator' - + The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS 'vision.googleapis.com' - + The default address of the service. - + + - + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + + The address template of the service. + + + + + + DEFAULT_SERVICE_PORT \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::DEFAULT_SERVICE_PORT 443 - + The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::CODEGEN_NAME 'gapic' - + The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - + The default scopes required by the service. - + productSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$productSetNameTemplate - + - + pathTemplateMap \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$pathTemplateMap - + - + operationsClient \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$operationsClient - + @@ -18341,62 +18323,62 @@ This service has a new (beta) implementation. See {@see \Google\Cloud\Vision\V1\ - + getClientDefaults \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getClientDefaults() - + - + getProductSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getProductSetNameTemplate() - + - + getPathTemplateMap \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getPathTemplateMap() - + - + productSetName \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::productSetName() - + project string - + location string - + productSet string - + Formats a string containing the fully-qualified path to represent a product_set resource. @@ -18420,23 +18402,23 @@ resource. - + parseName \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::parseName() - + formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -18467,11 +18449,11 @@ the first match. - + getOperationsClient \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getOperationsClient() - + Return an OperationsClient object with the same endpoint as $this. - + resumeOperation \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::resumeOperation() - + operationName string - + methodName null string - + Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the @@ -18520,17 +18502,17 @@ OperationResponse object will not deserialize the final response. - + __construct \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::__construct() - + options [] array - + Constructor. - + asyncBatchAnnotateFiles \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateFiles() - + requests \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] - + optionalArgs [] array - + Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the @@ -18610,7 +18592,7 @@ try { variable="requests" type="\Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[]"/> - + asyncBatchAnnotateImages \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateImages() - + requests \Google\Cloud\Vision\V1\AnnotateImageRequest[] - + outputConfig \Google\Cloud\Vision\V1\OutputConfig - + optionalArgs [] array - + Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. @@ -18702,7 +18684,7 @@ try { variable="outputConfig" type="\Google\Cloud\Vision\V1\OutputConfig"/> - + batchAnnotateFiles \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateFiles() - + requests \Google\Cloud\Vision\V1\AnnotateFileRequest[] - + optionalArgs [] array - + Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. @@ -18753,11 +18735,11 @@ try { ``` - + batchAnnotateImages \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateImages() - + requests \Google\Cloud\Vision\V1\AnnotateImageRequest[] - + optionalArgs [] array - + Run image detection and annotation for a batch of images. Sample code: ``` @@ -18805,7 +18787,7 @@ try { variable="requests" type="\Google\Cloud\Vision\V1\AnnotateImageRequest[]"/> - + @@ -18843,22 +18825,24 @@ try { - + ProductSearchGapicClient \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + Service Description: Manages Products and ProductSets of reference images for use in product search. It uses the following resource model: - - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] resources, named -`projects/&#42;/locations/&#42;/productSets/*`, which acts as a way to put different -products into groups to limit identification. + - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] +resources, named `projects/&#42;/locations/&#42;/productSets/*`, which acts as a way +to put different products into groups to limit identification. In parallel, -- The API has a collection of [Product][google.cloud.vision.v1.Product] resources, named +- The API has a collection of [Product][google.cloud.vision.v1.Product] +resources, named `projects/&#42;/locations/&#42;/products/*` -- Each [Product][google.cloud.vision.v1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named +- Each [Product][google.cloud.vision.v1.Product] has a collection of +[ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named `projects/&#42;/locations/&#42;/products/&#42;/referenceImages/*` This class provides the ability to make remote calls to the backing service through method @@ -18878,10 +18862,12 @@ try { Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - -This service has a new (beta) implementation. See {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient} to use the new surface. +contained within formatted names that are returned by the API. + @@ -18889,122 +18875,137 @@ This service has a new (beta) implementation. See {@see \Google\Cloud\Vision\V1\ - + SERVICE_NAME \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_NAME 'google.cloud.vision.v1.ProductSearch' - + The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS 'vision.googleapis.com' - + The default address of the service. - + + - + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + + The address template of the service. + + + + + + DEFAULT_SERVICE_PORT \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::DEFAULT_SERVICE_PORT 443 - + The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::CODEGEN_NAME 'gapic' - + The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - + The default scopes required by the service. - + locationNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$locationNameTemplate - + - + productNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productNameTemplate - + - + productSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productSetNameTemplate - + - + referenceImageNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$referenceImageNameTemplate - + - + pathTemplateMap \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$pathTemplateMap - + - + operationsClient \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$operationsClient - + @@ -19012,89 +19013,89 @@ This service has a new (beta) implementation. See {@see \Google\Cloud\Vision\V1\ - + getClientDefaults \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getClientDefaults() - + - + getLocationNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getLocationNameTemplate() - + - + getProductNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductNameTemplate() - + - + getProductSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSetNameTemplate() - + - + getReferenceImageNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImageNameTemplate() - + - + getPathTemplateMap \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getPathTemplateMap() - + - + locationName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::locationName() - + project string - + location string - + Formats a string containing the fully-qualified path to represent a location resource. @@ -19114,29 +19115,29 @@ resource. - + productName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productName() - + project string - + location string - + product string - + Formats a string containing the fully-qualified path to represent a product resource. @@ -19160,29 +19161,29 @@ resource. - + productSetName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productSetName() - + project string - + location string - + productSet string - + Formats a string containing the fully-qualified path to represent a product_set resource. @@ -19206,35 +19207,35 @@ resource. - + referenceImageName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::referenceImageName() - + project string - + location string - + product string - + referenceImage string - + Formats a string containing the fully-qualified path to represent a reference_image resource. @@ -19262,23 +19263,23 @@ reference_image resource. - + parseName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::parseName() - + formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -19312,11 +19313,11 @@ the first match. - + getOperationsClient \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getOperationsClient() - + Return an OperationsClient object with the same endpoint as $this. - + resumeOperation \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::resumeOperation() - + operationName string - + methodName null string - + Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the @@ -19365,17 +19366,17 @@ OperationResponse object will not deserialize the final response. - + __construct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::__construct() - + options [] array - + Constructor. - + addProductToProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::addProductToProductSet() - + name string - + product string - + optionalArgs [] array - + Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. @@ -19452,29 +19453,29 @@ try { - + createProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProduct() - + parent string - + product \Google\Cloud\Vision\V1\Product - + optionalArgs [] array - + Creates and returns a new product resource. Possible errors: @@ -19518,29 +19519,29 @@ try { - + createProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProductSet() - + parent string - + productSet \Google\Cloud\Vision\V1\ProductSet - + optionalArgs [] array - + Creates and returns a new ProductSet resource. Possible errors: @@ -19582,29 +19583,29 @@ try { - + createReferenceImage \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createReferenceImage() - + parent string - + referenceImage \Google\Cloud\Vision\V1\ReferenceImage - + optionalArgs [] array - + Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are @@ -19637,7 +19638,7 @@ try { ``` - + deleteProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProduct() - + name string - + optionalArgs [] array - + Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work @@ -19707,23 +19708,23 @@ try { - + deleteProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProductSet() - + name string - + optionalArgs [] array - + Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. @@ -19754,23 +19755,23 @@ try { - + deleteReferenceImage \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteReferenceImage() - + name string - + optionalArgs [] array - + Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related @@ -19804,23 +19805,23 @@ try { - + getProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProduct() - + name string - + optionalArgs [] array - + Gets information associated with a Product. Possible errors: @@ -19856,23 +19857,23 @@ try { - + getProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSet() - + name string - + optionalArgs [] array - + Gets information associated with a ProductSet. Possible errors: @@ -19908,23 +19909,23 @@ try { - + getReferenceImage \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImage() - + name string - + optionalArgs [] array - + Gets information associated with a ReferenceImage. Possible errors: @@ -19960,33 +19961,33 @@ try { - + importProductSets \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::importProductSets() - + parent string - + inputConfig \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - + optionalArgs [] array - + Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. - The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. + The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) @@ -20054,23 +20055,23 @@ try { - + listProductSets \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductSets() - + parent string - + optionalArgs [] array - + Lists ProductSets in an unspecified order. Possible errors: @@ -20119,23 +20120,23 @@ try { - + listProducts \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProducts() - + parent string - + optionalArgs [] array - + Lists products in an unspecified order. Possible errors: @@ -20183,23 +20184,23 @@ try { - + listProductsInProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductsInProductSet() - + name string - + optionalArgs [] array - + Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. @@ -20249,23 +20250,23 @@ try { - + listReferenceImages \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listReferenceImages() - + parent string - + optionalArgs [] array - + Lists reference images. Possible errors: @@ -20315,23 +20316,23 @@ try { - + purgeProducts \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::purgeProducts() - + parent string - + optionalArgs [] array - + Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other @@ -20352,8 +20353,8 @@ re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. -The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. +The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) Sample code: @@ -20409,29 +20410,29 @@ try { - + removeProductFromProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::removeProductFromProductSet() - + name string - + product string - + optionalArgs [] array - + Removes a Product from the specified ProductSet. Sample code: ``` @@ -20450,7 +20451,7 @@ try { variable="name" type="string"/> - + updateProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProduct() - + product \Google\Cloud\Vision\V1\Product - + optionalArgs [] array - + Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. @@ -20527,23 +20528,23 @@ try { - + updateProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProductSet() - + productSet \Google\Cloud\Vision\V1\ProductSet - + optionalArgs [] array - + Makes changes to a ProductSet resource. Only display_name can be updated currently. @@ -20667,7 +20668,7 @@ Generated from protobuf field <code>string uri = 1;</code> @@ -21727,108 +21728,123 @@ ImageAnnotator service returns detected entities from the images. \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - + SERVICE_NAME \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_NAME 'google.cloud.vision.v1.ImageAnnotator' - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS 'vision.googleapis.com' - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient The default address of the service. - + + - + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + The address template of the service. + + + + + + DEFAULT_SERVICE_PORT \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::DEFAULT_SERVICE_PORT 443 - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::CODEGEN_NAME 'gapic' - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient The name of the code generator, to be included in the agent header. - + - - urlSchemes - \Google\Cloud\Vision\VisionHelpersTrait::$urlSchemes - ['http', 'https', 'gs'] - \Google\Cloud\Vision\VisionHelpersTrait - A list of allowed url schemes. - - - - - - - + serviceScopes \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient The default scopes required by the service. - + productSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$productSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - + pathTemplateMap \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$pathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - + operationsClient \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$operationsClient - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + + + + urlSchemes + \Google\Cloud\Vision\VisionHelpersTrait::$urlSchemes + ['http', 'https', 'gs'] + \Google\Cloud\Vision\VisionHelpersTrait + A list of allowed url schemes. + + + + @@ -22518,207 +22534,62 @@ $response = $imageAnnotatorClient->productSearch( - - annotateImageHelper - \Google\Cloud\Vision\VisionHelpersTrait::annotateImageHelper() - - \Google\Cloud\Vision\VisionHelpersTrait - callback - - callable - - - - requestClass - - \Google\Cloud\Vision\V1\AnnotateImageRequest|mixed - - - - image - - \Google\Cloud\Vision\Image|mixed - - - - features - - \Google\Cloud\Vision\V1\Feature[]|int[] - - - - optionalArgs - [] - array - - - - - - - - - - - - - - - - - buildFeatureList - \Google\Cloud\Vision\VisionHelpersTrait::buildFeatureList() - - \Google\Cloud\Vision\VisionHelpersTrait - featureClass - - string - - - - featureTypes - - \Google\Cloud\Vision\V1\Feature[]|int[] - - - - - - - - - - - - - - createImageHelper - \Google\Cloud\Vision\VisionHelpersTrait::createImageHelper() - - \Google\Cloud\Vision\VisionHelpersTrait - imageClass - - string - - - - imageSourceClass - - string - - - - imageInput - - string|resource|\Google\Cloud\Vision\Image|mixed - - - - - - - - - - - - - - + getClientDefaults \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getClientDefaults() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - + getProductSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getProductSetNameTemplate() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - + getPathTemplateMap \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getPathTemplateMap() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - + productSetName \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::productSetName() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient project string - + location string - + productSet string - + Formats a string containing the fully-qualified path to represent a product_set resource. @@ -22742,23 +22613,23 @@ resource. - + parseName \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::parseName() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -22789,11 +22660,11 @@ the first match. - + getOperationsClient \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getOperationsClient() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient Return an OperationsClient object with the same endpoint as $this. - + resumeOperation \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::resumeOperation() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient operationName string - + methodName null string - + Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the @@ -22842,17 +22713,17 @@ OperationResponse object will not deserialize the final response. - + __construct \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::__construct() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient options [] array - + Constructor. - + asyncBatchAnnotateFiles \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateFiles() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient requests \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] - + optionalArgs [] array - + Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the @@ -22932,7 +22803,7 @@ try { variable="requests" type="\Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[]"/> - + asyncBatchAnnotateImages \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateImages() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient requests \Google\Cloud\Vision\V1\AnnotateImageRequest[] - + outputConfig \Google\Cloud\Vision\V1\OutputConfig - + optionalArgs [] array - + Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. @@ -23024,7 +22895,7 @@ try { variable="outputConfig" type="\Google\Cloud\Vision\V1\OutputConfig"/> - + batchAnnotateFiles \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateFiles() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient requests \Google\Cloud\Vision\V1\AnnotateFileRequest[] - + optionalArgs [] array - + Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. @@ -23075,11 +22946,11 @@ try { ``` - + batchAnnotateImages \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateImages() - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient + \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient requests \Google\Cloud\Vision\V1\AnnotateImageRequest[] - + optionalArgs [] array - + Run image detection and annotation for a batch of images. Sample code: ``` @@ -23127,7 +22998,7 @@ try { variable="requests" type="\Google\Cloud\Vision\V1\AnnotateImageRequest[]"/> + + + + annotateImageHelper + \Google\Cloud\Vision\VisionHelpersTrait::annotateImageHelper() + + \Google\Cloud\Vision\VisionHelpersTrait + callback + + callable + + + + requestClass + + \Google\Cloud\Vision\V1\AnnotateImageRequest|mixed + + + + image + + \Google\Cloud\Vision\Image|mixed + + + + features + + \Google\Cloud\Vision\V1\Feature[]|int[] + + + + optionalArgs + [] + array + + + + + + + + + + + + + + + + + buildFeatureList + \Google\Cloud\Vision\VisionHelpersTrait::buildFeatureList() + + \Google\Cloud\Vision\VisionHelpersTrait + featureClass + + string + + + + featureTypes + + \Google\Cloud\Vision\V1\Feature[]|int[] + + + + + + + + + + + + + + createImageHelper + \Google\Cloud\Vision\VisionHelpersTrait::createImageHelper() + + \Google\Cloud\Vision\VisionHelpersTrait + imageClass + + string + + + + imageSourceClass + + string + + + + imageInput + + string|resource|\Google\Cloud\Vision\Image|mixed + + + + + + + + + + + @@ -24274,7 +24290,7 @@ Generated from protobuf field <code>string image_uri = 2;</code> - + @@ -24308,11 +24324,11 @@ ImportProductSetRequests in each line. \Google\Protobuf\Internal\Message - + csv_file_uri \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::$csv_file_uri '' - + The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. @@ -24333,13 +24349,15 @@ If the `ProductSet` or `Product` specified by the `product-set-id` and `product-display-name` column refers to [display_name][google.cloud.vision.v1.Product.display_name], the `product-category` column refers to -[product_category][google.cloud.vision.v1.Product.product_category], and the -`labels` column refers to [product_labels][google.cloud.vision.v1.Product.product_labels]. +[product_category][google.cloud.vision.v1.Product.product_category], and +the `labels` column refers to +[product_labels][google.cloud.vision.v1.Product.product_labels]. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system -sets the [display_name][google.cloud.vision.v1.Product.display_name] field for the product to a -space (" "). You can update the `display_name` later by using the API. +sets the [display_name][google.cloud.vision.v1.Product.display_name] field +for the product to a space (" "). You can update the `display_name` later +by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. @@ -24367,32 +24385,32 @@ Generated from protobuf field <code>string csv_file_uri = 1;</code>< - + __construct \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::__construct() - + data NULL array - + Constructor. - + getCsvFileUri \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::getCsvFileUri() - + The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. @@ -24413,13 +24431,15 @@ If the `ProductSet` or `Product` specified by the `product-set-id` and `product-display-name` column refers to [display_name][google.cloud.vision.v1.Product.display_name], the `product-category` column refers to -[product_category][google.cloud.vision.v1.Product.product_category], and the -`labels` column refers to [product_labels][google.cloud.vision.v1.Product.product_labels]. +[product_category][google.cloud.vision.v1.Product.product_category], and +the `labels` column refers to +[product_labels][google.cloud.vision.v1.Product.product_labels]. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system -sets the [display_name][google.cloud.vision.v1.Product.display_name] field for the product to a -space (" "). You can update the `display_name` later by using the API. +sets the [display_name][google.cloud.vision.v1.Product.display_name] field +for the product to a space (" "). You can update the `display_name` later +by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. @@ -24450,17 +24470,17 @@ Generated from protobuf field <code>string csv_file_uri = 1;</code>< - + setCsvFileUri \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::setCsvFileUri() - + var string - + The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. @@ -24481,13 +24501,15 @@ If the `ProductSet` or `Product` specified by the `product-set-id` and `product-display-name` column refers to [display_name][google.cloud.vision.v1.Product.display_name], the `product-category` column refers to -[product_category][google.cloud.vision.v1.Product.product_category], and the -`labels` column refers to [product_labels][google.cloud.vision.v1.Product.product_labels]. +[product_category][google.cloud.vision.v1.Product.product_category], and +the `labels` column refers to +[product_labels][google.cloud.vision.v1.Product.product_labels]. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system -sets the [display_name][google.cloud.vision.v1.Product.display_name] field for the product to a -space (" "). You can update the `display_name` later by using the API. +sets the [display_name][google.cloud.vision.v1.Product.display_name] field +for the product to a space (" "). You can update the `display_name` later +by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. @@ -24898,7 +24920,7 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - + @@ -24916,14 +24938,16 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - + ImportProductSetsResponse \Google\Cloud\Vision\V1\ImportProductSetsResponse - + Response message for the `ImportProductSets` method. This message is returned by the -[google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned -[google.longrunning.Operation.response][google.longrunning.Operation.response] field. +[google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] +method in the returned +[google.longrunning.Operation.response][google.longrunning.Operation.response] +field. Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsResponse</code> \Google\Protobuf\Internal\Message - + reference_images \Google\Cloud\Vision\V1\ImportProductSetsResponse::$reference_images - + The list of reference_images that are imported successfully. Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> - + statuses \Google\Cloud\Vision\V1\ImportProductSetsResponse::$statuses - + The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, @@ -24963,17 +24987,17 @@ Generated from protobuf field <code>repeated .google.rpc.Status statuses = - + __construct \Google\Cloud\Vision\V1\ImportProductSetsResponse::__construct() - + data NULL array - + Constructor. - + getReferenceImages \Google\Cloud\Vision\V1\ImportProductSetsResponse::getReferenceImages() - + The list of reference_images that are imported successfully. Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> - + setReferenceImages \Google\Cloud\Vision\V1\ImportProductSetsResponse::setReferenceImages() - + var \Google\Cloud\Vision\V1\ReferenceImage[]|\Google\Protobuf\Internal\RepeatedField - + The list of reference_images that are imported successfully. Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> - + getStatuses \Google\Cloud\Vision\V1\ImportProductSetsResponse::getStatuses() - + The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, @@ -25044,17 +25068,17 @@ Generated from protobuf field <code>repeated .google.rpc.Status statuses = - + setStatuses \Google\Cloud\Vision\V1\ImportProductSetsResponse::setStatuses() - + var \Google\Rpc\Status[]|\Google\Protobuf\Internal\RepeatedField - + The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, @@ -25581,7 +25605,7 @@ highly stable results across model upgrades. Unknown likelihood. Generated from protobuf enum <code>UNKNOWN = 0;</code> - + @@ -25592,7 +25616,7 @@ highly stable results across model upgrades. It is very unlikely. Generated from protobuf enum <code>VERY_UNLIKELY = 1;</code> - + @@ -25603,7 +25627,7 @@ highly stable results across model upgrades. It is unlikely. Generated from protobuf enum <code>UNLIKELY = 2;</code> - + @@ -25614,7 +25638,7 @@ highly stable results across model upgrades. It is possible. Generated from protobuf enum <code>POSSIBLE = 3;</code> - + @@ -25625,7 +25649,7 @@ highly stable results across model upgrades. It is likely. Generated from protobuf enum <code>LIKELY = 4;</code> - + @@ -25636,7 +25660,7 @@ highly stable results across model upgrades. It is very likely. Generated from protobuf enum <code>VERY_LIKELY = 5;</code> - + @@ -28102,7 +28126,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer Invalid. Generated from protobuf enum <code>STATE_UNSPECIFIED = 0;</code> - + @@ -28113,7 +28137,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer Request is received. Generated from protobuf enum <code>CREATED = 1;</code> - + @@ -28124,7 +28148,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer Request is actively being processed. Generated from protobuf enum <code>RUNNING = 2;</code> - + @@ -28135,7 +28159,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer The batch processing is done. Generated from protobuf enum <code>DONE = 3;</code> - + @@ -28146,7 +28170,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer The batch processing was cancelled. Generated from protobuf enum <code>CANCELLED = 4;</code> - + @@ -29169,7 +29193,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b @@ -29801,7 +29825,7 @@ cannot exceed 128 bytes. - + @@ -29873,25 +29897,27 @@ characters long. - + product_category \Google\Cloud\Vision\V1\Product::$product_category '' - - Immutable. The category for the product identified by the reference image. This should -be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or -"general-v1". The legacy categories "homegoods", "apparel", and "toys" are -still supported, but these should not be used for new products. - Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> + + Immutable. The category for the product identified by the reference image. + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", +"apparel", and "toys" are still supported, but these should not be used for +new products. + +Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> - + product_labels \Google\Cloud\Vision\V1\Product::$product_labels - + Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only @@ -29909,32 +29935,32 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Produ - + __construct \Google\Cloud\Vision\V1\Product::__construct() - + data NULL array - + Constructor. - + getName \Google\Cloud\Vision\V1\Product::getName() - + The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @@ -29949,17 +29975,17 @@ Generated from protobuf field <code>string name = 1;</code> - + setName \Google\Cloud\Vision\V1\Product::setName() - + var string - + The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @@ -29978,11 +30004,11 @@ Generated from protobuf field <code>string name = 1;</code> - + getDisplayName \Google\Cloud\Vision\V1\Product::getDisplayName() - + The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. Generated from protobuf field <code>string display_name = 2;</code> @@ -29994,17 +30020,17 @@ Generated from protobuf field <code>string name = 1;</code> - + setDisplayName \Google\Cloud\Vision\V1\Product::setDisplayName() - + var string - + The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. Generated from protobuf field <code>string display_name = 2;</code> @@ -30020,11 +30046,11 @@ Generated from protobuf field <code>string name = 1;</code> - + getDescription \Google\Cloud\Vision\V1\Product::getDescription() - + User-provided metadata to be stored with this product. Must be at most 4096 characters long. Generated from protobuf field <code>string description = 3;</code> @@ -30036,17 +30062,17 @@ characters long. - + setDescription \Google\Cloud\Vision\V1\Product::setDescription() - + var string - + User-provided metadata to be stored with this product. Must be at most 4096 characters long. Generated from protobuf field <code>string description = 3;</code> @@ -30062,16 +30088,18 @@ characters long. - + getProductCategory \Google\Cloud\Vision\V1\Product::getProductCategory() - - Immutable. The category for the product identified by the reference image. This should -be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or -"general-v1". The legacy categories "homegoods", "apparel", and "toys" are -still supported, but these should not be used for new products. - Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> + + Immutable. The category for the product identified by the reference image. + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", +"apparel", and "toys" are still supported, but these should not be used for +new products. + +Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> - + setProductCategory \Google\Cloud\Vision\V1\Product::setProductCategory() - + var string - - Immutable. The category for the product identified by the reference image. This should -be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or -"general-v1". The legacy categories "homegoods", "apparel", and "toys" are -still supported, but these should not be used for new products. - Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> + + Immutable. The category for the product identified by the reference image. + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", +"apparel", and "toys" are still supported, but these should not be used for +new products. + +Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> - + getProductLabels \Google\Cloud\Vision\V1\Product::getProductLabels() - + Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only @@ -30133,17 +30163,17 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Produ - + setProductLabels \Google\Cloud\Vision\V1\Product::setProductLabels() - + var \Google\Cloud\Vision\V1\Product\KeyValue[]|\Google\Protobuf\Internal\RepeatedField - + Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only @@ -30251,122 +30281,137 @@ search. It uses the following resource model: \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + SERVICE_NAME \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_NAME 'google.cloud.vision.v1.ProductSearch' - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient The name of the service. - + - + SERVICE_ADDRESS \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS 'vision.googleapis.com' - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient The default address of the service. - + + - + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + The address template of the service. + + + + + + DEFAULT_SERVICE_PORT \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::DEFAULT_SERVICE_PORT 443 - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient The default port of the service. - + - + CODEGEN_NAME \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::CODEGEN_NAME 'gapic' - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient The name of the code generator, to be included in the agent header. - + - + serviceScopes \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$serviceScopes ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient The default scopes required by the service. - + locationNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$locationNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + productNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + productSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + referenceImageNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$referenceImageNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + pathTemplateMap \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$pathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + operationsClient \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$operationsClient - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient @@ -30374,89 +30419,89 @@ search. It uses the following resource model: - + getClientDefaults \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getClientDefaults() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + getLocationNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getLocationNameTemplate() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + getProductNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductNameTemplate() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + getProductSetNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSetNameTemplate() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + getReferenceImageNameTemplate \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImageNameTemplate() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + getPathTemplateMap \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getPathTemplateMap() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + locationName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::locationName() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient project string - + location string - + Formats a string containing the fully-qualified path to represent a location resource. @@ -30476,29 +30521,29 @@ resource. - + productName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productName() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient project string - + location string - + product string - + Formats a string containing the fully-qualified path to represent a product resource. @@ -30522,29 +30567,29 @@ resource. - + productSetName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productSetName() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient project string - + location string - + productSet string - + Formats a string containing the fully-qualified path to represent a product_set resource. @@ -30568,35 +30613,35 @@ resource. - + referenceImageName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::referenceImageName() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient project string - + location string - + product string - + referenceImage string - + Formats a string containing the fully-qualified path to represent a reference_image resource. @@ -30624,23 +30669,23 @@ reference_image resource. - + parseName \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::parseName() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient formattedName string - + template null string - + Parses a formatted name string and returns an associative array of the components in the name. The following name formats are supported: Template: Pattern @@ -30674,11 +30719,11 @@ the first match. - + getOperationsClient \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getOperationsClient() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient Return an OperationsClient object with the same endpoint as $this. - + resumeOperation \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::resumeOperation() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient operationName string - + methodName null string - + Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the @@ -30727,17 +30772,17 @@ OperationResponse object will not deserialize the final response. - + __construct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::__construct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient options [] array - + Constructor. - + addProductToProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::addProductToProductSet() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + product string - + optionalArgs [] array - + Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. @@ -30814,29 +30859,29 @@ try { - + createProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProduct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + product \Google\Cloud\Vision\V1\Product - + optionalArgs [] array - + Creates and returns a new product resource. Possible errors: @@ -30880,29 +30925,29 @@ try { - + createProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProductSet() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + productSet \Google\Cloud\Vision\V1\ProductSet - + optionalArgs [] array - + Creates and returns a new ProductSet resource. Possible errors: @@ -30944,29 +30989,29 @@ try { - + createReferenceImage \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createReferenceImage() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + referenceImage \Google\Cloud\Vision\V1\ReferenceImage - + optionalArgs [] array - + Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are @@ -30999,7 +31044,7 @@ try { ``` - + deleteProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProduct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + optionalArgs [] array - + Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work @@ -31069,23 +31114,23 @@ try { - + deleteProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProductSet() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + optionalArgs [] array - + Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. @@ -31116,23 +31161,23 @@ try { - + deleteReferenceImage \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteReferenceImage() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + optionalArgs [] array - + Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related @@ -31166,23 +31211,23 @@ try { - + getProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProduct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + optionalArgs [] array - + Gets information associated with a Product. Possible errors: @@ -31218,23 +31263,23 @@ try { - + getProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSet() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + optionalArgs [] array - + Gets information associated with a ProductSet. Possible errors: @@ -31270,23 +31315,23 @@ try { - + getReferenceImage \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImage() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + optionalArgs [] array - + Gets information associated with a ReferenceImage. Possible errors: @@ -31322,33 +31367,33 @@ try { - + importProductSets \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::importProductSets() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + inputConfig \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - + optionalArgs [] array - + Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. - The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. + The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) @@ -31416,23 +31461,23 @@ try { - + listProductSets \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductSets() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + optionalArgs [] array - + Lists ProductSets in an unspecified order. Possible errors: @@ -31481,23 +31526,23 @@ try { - + listProducts \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProducts() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + optionalArgs [] array - + Lists products in an unspecified order. Possible errors: @@ -31545,23 +31590,23 @@ try { - + listProductsInProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductsInProductSet() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + optionalArgs [] array - + Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. @@ -31611,23 +31656,23 @@ try { - + listReferenceImages \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listReferenceImages() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + optionalArgs [] array - + Lists reference images. Possible errors: @@ -31677,23 +31722,23 @@ try { - + purgeProducts \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::purgeProducts() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient parent string - + optionalArgs [] array - + Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other @@ -31714,8 +31759,8 @@ re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. -The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. +The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) Sample code: @@ -31771,29 +31816,29 @@ try { - + removeProductFromProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::removeProductFromProductSet() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient name string - + product string - + optionalArgs [] array - + Removes a Product from the specified ProductSet. Sample code: ``` @@ -31812,7 +31857,7 @@ try { variable="name" type="string"/> - + updateProduct \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProduct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient product \Google\Cloud\Vision\V1\Product - + optionalArgs [] array - + Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. @@ -31889,23 +31934,23 @@ try { - + updateProductSet \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProductSet() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient productSet \Google\Cloud\Vision\V1\ProductSet - + optionalArgs [] array - + Makes changes to a ProductSet resource. Only display_name can be updated currently. @@ -33001,7 +33046,7 @@ progress and results of the request. - + @@ -33047,12 +33092,13 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + product_set \Google\Cloud\Vision\V1\ProductSearchParams::$product_set '' - - The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to be searched for similar images. + + The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to +be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. @@ -33061,11 +33107,11 @@ Generated from protobuf field <code>string product_set = 6 [(.google.api.r - + product_categories \Google\Cloud\Vision\V1\ProductSearchParams::$product_categories - + The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy @@ -33078,11 +33124,11 @@ migrate existing products to these categories as well. - + filter \Google\Cloud\Vision\V1\ProductSearchParams::$filter '' - + The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An @@ -33097,32 +33143,32 @@ Generated from protobuf field <code>string filter = 8;</code> - + __construct \Google\Cloud\Vision\V1\ProductSearchParams::__construct() - + data NULL array - + Constructor. - + getBoundingPoly \Google\Cloud\Vision\V1\ProductSearchParams::getBoundingPoly() - + The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied. @@ -33135,39 +33181,39 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + hasBoundingPoly \Google\Cloud\Vision\V1\ProductSearchParams::hasBoundingPoly() - + - + clearBoundingPoly \Google\Cloud\Vision\V1\ProductSearchParams::clearBoundingPoly() - + - + setBoundingPoly \Google\Cloud\Vision\V1\ProductSearchParams::setBoundingPoly() - + var \Google\Cloud\Vision\V1\BoundingPoly - + The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied. @@ -33184,12 +33230,13 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + getProductSet \Google\Cloud\Vision\V1\ProductSearchParams::getProductSet() - - The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to be searched for similar images. + + The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to +be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. @@ -33202,18 +33249,19 @@ Generated from protobuf field <code>string product_set = 6 [(.google.api.r - + setProductSet \Google\Cloud\Vision\V1\ProductSearchParams::setProductSet() - + var string - - The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to be searched for similar images. + + The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to +be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. @@ -33230,11 +33278,11 @@ Generated from protobuf field <code>string product_set = 6 [(.google.api.r - + getProductCategories \Google\Cloud\Vision\V1\ProductSearchParams::getProductCategories() - + The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy @@ -33251,17 +33299,17 @@ migrate existing products to these categories as well. - + setProductCategories \Google\Cloud\Vision\V1\ProductSearchParams::setProductCategories() - + var string[]|\Google\Protobuf\Internal\RepeatedField - + The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy @@ -33282,11 +33330,11 @@ migrate existing products to these categories as well. - + getFilter \Google\Cloud\Vision\V1\ProductSearchParams::getFilter() - + The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An @@ -33304,17 +33352,17 @@ Generated from protobuf field <code>string filter = 8;</code> - + setFilter \Google\Cloud\Vision\V1\ProductSearchParams::setFilter() - + var string - + The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An @@ -35488,7 +35536,7 @@ the purge. - + @@ -35555,10 +35603,10 @@ Generated from protobuf field <code>string uri = 2 [(.google.api.field_beh \Google\Cloud\Vision\V1\ReferenceImage::$bounding_polys - Optional. Bounding polygons around the areas of interest in the reference image. - If this field is empty, the system will try to detect regions of -interest. At most 10 bounding polygons will be used. -The provided shape is converted into a non-rotated rectangle. Once + Optional. Bounding polygons around the areas of interest in the reference +image. If this field is empty, the system will try to detect regions of +interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). @@ -35584,7 +35632,7 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Bound @@ -35687,10 +35735,10 @@ Generated from protobuf field <code>string uri = 2 [(.google.api.field_beh \Google\Cloud\Vision\V1\ReferenceImage::getBoundingPolys() - Optional. Bounding polygons around the areas of interest in the reference image. - If this field is empty, the system will try to detect regions of -interest. At most 10 bounding polygons will be used. -The provided shape is converted into a non-rotated rectangle. Once + Optional. Bounding polygons around the areas of interest in the reference +image. If this field is empty, the system will try to detect regions of +interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). @@ -35715,10 +35763,10 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Bound - Optional. Bounding polygons around the areas of interest in the reference image. - If this field is empty, the system will try to detect regions of -interest. At most 10 bounding polygons will be used. -The provided shape is converted into a non-rotated rectangle. Once + Optional. Bounding polygons around the areas of interest in the reference +image. If this field is empty, the system will try to detect regions of +interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). @@ -35742,7 +35790,7 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Bound - + @@ -35789,12 +35837,13 @@ Generated from protobuf field <code>string name = 1 [(.google.api.field_be - + product \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::$product '' - - Required. The resource name for the Product to be removed from this ProductSet. + + Required. The resource name for the Product to be removed from this +ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` @@ -35804,23 +35853,23 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field - + build \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::build() - + name string - + product string - + - + __construct \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::__construct() - + data NULL array - + Constructor. - + getName \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::getName() - + Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` @@ -35882,17 +35931,17 @@ Generated from protobuf field <code>string name = 1 [(.google.api.field_be - + setName \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::setName() - + var string - + Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` @@ -35910,12 +35959,13 @@ Generated from protobuf field <code>string name = 1 [(.google.api.field_be - + getProduct \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::getProduct() - - Required. The resource name for the Product to be removed from this ProductSet. + + Required. The resource name for the Product to be removed from this +ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` @@ -35928,18 +35978,19 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field - + setProduct \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::setProduct() - + var string - - Required. The resource name for the Product to be removed from this ProductSet. + + Required. The resource name for the Product to be removed from this +ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` @@ -35962,7 +36013,7 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field - + @@ -35984,7 +36035,7 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field - + @@ -36006,7 +36057,7 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field - + @@ -36028,7 +36079,7 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field - + @@ -36050,7 +36101,7 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field - + @@ -36122,22 +36173,24 @@ funny or offensive. - + violence \Google\Cloud\Vision\V1\SafeSearchAnnotation::$violence 0 - - Likelihood that this image contains violent content. + + Likelihood that this image contains violent content. Violent content may +include death, serious harm, or injury to individuals or groups of +individuals. Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> - + racy \Google\Cloud\Vision\V1\SafeSearchAnnotation::$racy 0 - + Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive @@ -36148,32 +36201,32 @@ body areas. - + __construct \Google\Cloud\Vision\V1\SafeSearchAnnotation::__construct() - + data NULL array - + Constructor. - + getAdult \Google\Cloud\Vision\V1\SafeSearchAnnotation::getAdult() - + Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. @@ -36186,17 +36239,17 @@ sexual activities. - + setAdult \Google\Cloud\Vision\V1\SafeSearchAnnotation::setAdult() - + var int - + Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. @@ -36213,11 +36266,11 @@ sexual activities. - + getSpoof \Google\Cloud\Vision\V1\SafeSearchAnnotation::getSpoof() - + Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. @@ -36230,17 +36283,17 @@ funny or offensive. - + setSpoof \Google\Cloud\Vision\V1\SafeSearchAnnotation::setSpoof() - + var int - + Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. @@ -36257,11 +36310,11 @@ funny or offensive. - + getMedical \Google\Cloud\Vision\V1\SafeSearchAnnotation::getMedical() - + Likelihood that this is a medical image. Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> - + setMedical \Google\Cloud\Vision\V1\SafeSearchAnnotation::setMedical() - + var int - + Likelihood that this is a medical image. Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> - + getViolence \Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolence() - - Likelihood that this image contains violent content. + + Likelihood that this image contains violent content. Violent content may +include death, serious harm, or injury to individuals or groups of +individuals. Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> - + setViolence \Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolence() - + var int - - Likelihood that this image contains violent content. + + Likelihood that this image contains violent content. Violent content may +include death, serious harm, or injury to individuals or groups of +individuals. Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> - + getRacy \Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacy() - + Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive @@ -36355,17 +36412,17 @@ body areas. - + setRacy \Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacy() - + var int - + Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive @@ -36383,11 +36440,11 @@ body areas. - + getAdultConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::getAdultConfidence() - + Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float adult_confidence = 16 [deprecated = true];</code> @@ -36403,17 +36460,17 @@ very confident. - + setAdultConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::setAdultConfidence() - + var float - + Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float adult_confidence = 16 [deprecated = true];</code> @@ -36433,11 +36490,11 @@ very confident. - + getSpoofConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::getSpoofConfidence() - + Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float spoof_confidence = 18 [deprecated = true];</code> @@ -36453,17 +36510,17 @@ very confident. - + setSpoofConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::setSpoofConfidence() - + var float - + Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float spoof_confidence = 18 [deprecated = true];</code> @@ -36483,11 +36540,11 @@ very confident. - + getMedicalConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::getMedicalConfidence() - + Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float medical_confidence = 20 [deprecated = true];</code> @@ -36503,17 +36560,17 @@ very confident. - + setMedicalConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::setMedicalConfidence() - + var float - + Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float medical_confidence = 20 [deprecated = true];</code> @@ -36533,11 +36590,11 @@ very confident. - + getViolenceConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolenceConfidence() - + Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float violence_confidence = 22 [deprecated = true];</code> @@ -36553,17 +36610,17 @@ very confident. - + setViolenceConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolenceConfidence() - + var float - + Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float violence_confidence = 22 [deprecated = true];</code> @@ -36583,11 +36640,11 @@ very confident. - + getRacyConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacyConfidence() - + Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float racy_confidence = 24 [deprecated = true];</code> @@ -36603,17 +36660,17 @@ confident. - + setRacyConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacyConfidence() - + var float - + Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float racy_confidence = 24 [deprecated = true];</code> @@ -36633,11 +36690,11 @@ confident. - + getNsfwConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::getNsfwConfidence() - + Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float nsfw_confidence = 26 [deprecated = true];</code> @@ -36653,17 +36710,17 @@ confident. - + setNsfwConfidence \Google\Cloud\Vision\V1\SafeSearchAnnotation::setNsfwConfidence() - + var float - + Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. Generated from protobuf field <code>float nsfw_confidence = 26 [deprecated = true];</code> @@ -36797,7 +36854,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b @@ -37082,7 +37139,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b Unknown break label type. Generated from protobuf enum <code>UNKNOWN = 0;</code> - + @@ -37093,7 +37150,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b Regular space. Generated from protobuf enum <code>SPACE = 1;</code> - + @@ -37104,7 +37161,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b Sure space (very wide). Generated from protobuf enum <code>SURE_SPACE = 2;</code> - + @@ -37115,7 +37172,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b Line-wrapping break. Generated from protobuf enum <code>EOL_SURE_SPACE = 3;</code> - + @@ -37127,7 +37184,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`. Generated from protobuf enum <code>HYPHEN = 4;</code> - + @@ -37138,7 +37195,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b Line break that ends a paragraph. Generated from protobuf enum <code>LINE_BREAK = 5;</code> - + @@ -37712,7 +37769,7 @@ http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - + @@ -37730,17 +37787,18 @@ http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - + TextAnnotation \Google\Cloud\Vision\V1\TextAnnotation - + TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer -to the [TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty] message definition below for more -detail. +to the +[TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty] +message definition below for more detail. Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation</code> \Google\Protobuf\Internal\Message - + pages \Google\Cloud\Vision\V1\TextAnnotation::$pages - + List of pages detected by OCR. Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> - + text \Google\Cloud\Vision\V1\TextAnnotation::$text '' - + UTF-8 text detected on the pages. Generated from protobuf field <code>string text = 2;</code> @@ -37775,17 +37833,17 @@ Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotatio - + __construct \Google\Cloud\Vision\V1\TextAnnotation::__construct() - + data NULL array - + Constructor. - + getPages \Google\Cloud\Vision\V1\TextAnnotation::getPages() - + List of pages detected by OCR. Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> - + setPages \Google\Cloud\Vision\V1\TextAnnotation::setPages() - + var \Google\Cloud\Vision\V1\Page[]|\Google\Protobuf\Internal\RepeatedField - + List of pages detected by OCR. Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> - + getText \Google\Cloud\Vision\V1\TextAnnotation::getText() - + UTF-8 text detected on the pages. Generated from protobuf field <code>string text = 2;</code> - + setText \Google\Cloud\Vision\V1\TextAnnotation::setText() - + var string - + UTF-8 text detected on the pages. Generated from protobuf field <code>string text = 2;</code> - + @@ -38105,44 +38163,50 @@ score for TEXT_DETECTION as well. - + advanced_ocr_options \Google\Cloud\Vision\V1\TextDetectionParams::$advanced_ocr_options - - A list of advanced OCR options to fine-tune OCR behavior. - Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> + + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: +- `legacy_layout`: a heuristics layout detection algorithm, which serves as +an alternative to the current ML-based layout detection algorithm. +Customers can choose the best suitable layout algorithm based on their +situation. + +Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> - + __construct \Google\Cloud\Vision\V1\TextDetectionParams::__construct() - + data NULL array - + Constructor. - + getEnableTextDetectionConfidenceScore \Google\Cloud\Vision\V1\TextDetectionParams::getEnableTextDetectionConfidenceScore() - + By default, Cloud Vision API only includes confidence score for DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence score for TEXT_DETECTION as well. @@ -38155,17 +38219,17 @@ score for TEXT_DETECTION as well. - + setEnableTextDetectionConfidenceScore \Google\Cloud\Vision\V1\TextDetectionParams::setEnableTextDetectionConfidenceScore() - + var bool - + By default, Cloud Vision API only includes confidence score for DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence score for TEXT_DETECTION as well. @@ -38182,13 +38246,19 @@ score for TEXT_DETECTION as well. - + getAdvancedOcrOptions \Google\Cloud\Vision\V1\TextDetectionParams::getAdvancedOcrOptions() - - A list of advanced OCR options to fine-tune OCR behavior. - Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> + + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: +- `legacy_layout`: a heuristics layout detection algorithm, which serves as +an alternative to the current ML-based layout detection algorithm. +Customers can choose the best suitable layout algorithm based on their +situation. + +Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> - + setAdvancedOcrOptions \Google\Cloud\Vision\V1\TextDetectionParams::setAdvancedOcrOptions() - + var string[]|\Google\Protobuf\Internal\RepeatedField - - A list of advanced OCR options to fine-tune OCR behavior. - Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> + + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: +- `legacy_layout`: a heuristics layout detection algorithm, which serves as +an alternative to the current ML-based layout detection algorithm. +Customers can choose the best suitable layout algorithm based on their +situation. + +Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> - + @@ -40404,67 +40480,75 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDe \Google\Protobuf\Internal\Message - + include_geo_results \Google\Cloud\Vision\V1\WebDetectionParams::$include_geo_results false - - Whether to include results derived from the geo information in the image. - Generated from protobuf field <code>bool include_geo_results = 2;</code> - + + This field has no effect on results. + Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + + - + __construct \Google\Cloud\Vision\V1\WebDetectionParams::__construct() - + data NULL array - + Constructor. - + getIncludeGeoResults \Google\Cloud\Vision\V1\WebDetectionParams::getIncludeGeoResults() - - Whether to include results derived from the geo information in the image. - Generated from protobuf field <code>bool include_geo_results = 2;</code> + + This field has no effect on results. + Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + - + setIncludeGeoResults \Google\Cloud\Vision\V1\WebDetectionParams::setIncludeGeoResults() - + var bool - - Whether to include results derived from the geo information in the image. - Generated from protobuf field <code>bool include_geo_results = 2;</code> + + This field has no effect on results. + Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + @@ -40593,7 +40681,7 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbo @@ -40843,7 +40931,7 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbo - + Copyright 2016 Google Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); @@ -40904,11 +40992,11 @@ $vision = new VisionClient(); VERSION \Google\Cloud\Vision\VisionClient::VERSION - '1.7.4' + '1.10.1' - + @@ -40919,7 +41007,7 @@ $vision = new VisionClient(); - + @@ -41280,7 +41368,7 @@ limitations under the License. name="package" description="Application" /> - + urlSchemes