From c12ae4aacc597161211d53f15c60d6ab904d19d2 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 9 Jan 2024 13:44:06 -0500 Subject: [PATCH] fix(deps): [Many APIs] Update the Java code generator (gapic-generator-java) to 2.31.0 (#10194) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix(deps): Update the Java code generator (gapic-generator-java) to 2.31.0 PiperOrigin-RevId: 596645164 Source-Link: https://github.com/googleapis/googleapis/commit/4a0e62ecde2a6459bea8722a33173cfce1e9fb50 Source-Link: https://github.com/googleapis/googleapis-gen/commit/a10ed6a77676c37e60799098d48d0afb16008613 Copy-Tag: eyJwIjoiLmdpdGh1Yi9yZWxlYXNlLW5vdGUtZ2VuZXJhdGlvbi90ZXN0ZGF0YS9qYXZhLWFuYWx5dGljcy1hZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiLmdpdGh1Yi9yZWxlYXNlLW5vdGUtZ2VuZXJhdGlvbi90ZXN0ZGF0YS9qYXZhLW1hcHMtbWFwc3BsYXRmb3JtZGF0YXNldHMvLk93bEJvdC55YW1sIiwiaCI6ImExMGVkNmE3NzY3NmMzN2U2MDc5OTA5OGQ0OGQwYWZiMTYwMDg2MTMifQ== Copy-Tag: eyJwIjoiamF2YS1hY2Nlc3NhcHByb3ZhbC8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hY2Nlc3Njb250ZXh0bWFuYWdlci8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hZHZpc29yeW5vdGlmaWNhdGlvbnMvLk93bEJvdC55YW1sIiwiaCI6ImExMGVkNmE3NzY3NmMzN2U2MDc5OTA5OGQ0OGQwYWZiMTYwMDg2MTMifQ== Copy-Tag: eyJwIjoiamF2YS1haXBsYXRmb3JtLy5Pd2xCb3QueWFtbCIsImgiOiJhMTBlZDZhNzc2NzZjMzdlNjA3OTkwOThkNDhkMGFmYjE2MDA4NjEzIn0= Copy-Tag: eyJwIjoiamF2YS1hbGxveWRiLy5Pd2xCb3QueWFtbCIsImgiOiJhMTBlZDZhNzc2NzZjMzdlNjA3OTkwOThkNDhkMGFmYjE2MDA4NjEzIn0= Copy-Tag: eyJwIjoiamF2YS1hbmFseXRpY3MtYWRtaW4vLk93bEJvdC55YW1sIiwiaCI6ImExMGVkNmE3NzY3NmMzN2U2MDc5OTA5OGQ0OGQwYWZiMTYwMDg2MTMifQ== Copy-Tag: eyJwIjoiamF2YS1hbmFseXRpY3MtZGF0YS8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hbmFseXRpY3NodWIvLk93bEJvdC55YW1sIiwiaCI6ImExMGVkNmE3NzY3NmMzN2U2MDc5OTA5OGQ0OGQwYWZiMTYwMDg2MTMifQ== Copy-Tag: eyJwIjoiamF2YS1hcGktZ2F0ZXdheS8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hcGlnZWUtY29ubmVjdC8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hcGlnZWUtcmVnaXN0cnkvLk93bEJvdC55YW1sIiwiaCI6ImExMGVkNmE3NzY3NmMzN2U2MDc5OTA5OGQ0OGQwYWZiMTYwMDg2MTMifQ== Copy-Tag: eyJwIjoiamF2YS1hcGlrZXlzLy5Pd2xCb3QueWFtbCIsImgiOiJhMTBlZDZhNzc2NzZjMzdlNjA3OTkwOThkNDhkMGFmYjE2MDA4NjEzIn0= Copy-Tag: eyJwIjoiamF2YS1hcHBlbmdpbmUtYWRtaW4vLk93bEJvdC55YW1sIiwiaCI6ImExMGVkNmE3NzY3NmMzN2U2MDc5OTA5OGQ0OGQwYWZiMTYwMDg2MTMifQ== Copy-Tag: eyJwIjoiamF2YS1hcmVhMTIwLXRhYmxlcy8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hcnRpZmFjdC1yZWdpc3RyeS8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hc3NldC8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hc3N1cmVkLXdvcmtsb2Fkcy8uT3dsQm90LnlhbWwiLCJoIjoiYTEwZWQ2YTc3Njc2YzM3ZTYwNzk5MDk4ZDQ4ZDBhZmIxNjAwODYxMyJ9 Copy-Tag: eyJwIjoiamF2YS1hdXRvbWwvLk93bEJvdC55YW1sIiwiaCI6ImExMGVkNmE3NzY3NmMzN2U2MDc5OTA5OGQ0OGQwYWZiMTYwMDg2MTMifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- java-accessapproval/README.md | 2 +- .../v1/AccessApprovalAdminClient.java | 183 +- .../v1/stub/AccessApprovalStubSettings.java | 6 + java-accesscontextmanager/README.md | 2 +- .../v1/AccessContextManagerClient.java | 489 +++- .../AccessContextManagerStubSettings.java | 6 + java-advisorynotifications/README.md | 2 +- .../AdvisoryNotificationsServiceClient.java | 96 +- ...isoryNotificationsServiceStubSettings.java | 6 + java-aiplatform/README.md | 2 +- .../aiplatform/v1/DatasetServiceClient.java | 443 ++- .../DeploymentResourcePoolServiceClient.java | 191 +- .../aiplatform/v1/EndpointServiceClient.java | 252 +- .../FeatureOnlineStoreAdminServiceClient.java | 347 ++- .../v1/FeatureOnlineStoreServiceClient.java | 112 +- .../v1/FeatureRegistryServiceClient.java | 291 +- ...eaturestoreOnlineServingServiceClient.java | 142 +- .../v1/FeaturestoreServiceClient.java | 524 +++- .../v1/IndexEndpointServiceClient.java | 250 +- .../aiplatform/v1/IndexServiceClient.java | 219 +- .../cloud/aiplatform/v1/JobServiceClient.java | 773 +++++- .../v1/LlmUtilityServiceClient.java | 131 +- .../aiplatform/v1/MatchServiceClient.java | 121 +- .../aiplatform/v1/MetadataServiceClient.java | 711 ++++- .../aiplatform/v1/MigrationServiceClient.java | 133 +- .../v1/ModelGardenServiceClient.java | 112 +- .../aiplatform/v1/ModelServiceClient.java | 448 ++- .../aiplatform/v1/PipelineServiceClient.java | 287 +- .../v1/PredictionServiceClient.java | 226 +- .../aiplatform/v1/ScheduleServiceClient.java | 231 +- .../v1/SpecialistPoolServiceClient.java | 191 +- .../v1/TensorboardServiceClient.java | 655 ++++- .../aiplatform/v1/VizierServiceClient.java | 357 ++- .../v1/stub/DatasetServiceStubSettings.java | 6 + ...oymentResourcePoolServiceStubSettings.java | 6 + .../v1/stub/EndpointServiceStubSettings.java | 6 + ...reOnlineStoreAdminServiceStubSettings.java | 6 + ...FeatureOnlineStoreServiceStubSettings.java | 6 + .../FeatureRegistryServiceStubSettings.java | 6 + ...storeOnlineServingServiceStubSettings.java | 6 + .../stub/FeaturestoreServiceStubSettings.java | 6 + .../IndexEndpointServiceStubSettings.java | 6 + .../v1/stub/IndexServiceStubSettings.java | 6 + .../v1/stub/JobServiceStubSettings.java | 6 + .../stub/LlmUtilityServiceStubSettings.java | 6 + .../v1/stub/MatchServiceStubSettings.java | 6 + .../v1/stub/MetadataServiceStubSettings.java | 6 + .../v1/stub/MigrationServiceStubSettings.java | 6 + .../stub/ModelGardenServiceStubSettings.java | 6 + .../v1/stub/ModelServiceStubSettings.java | 6 + .../v1/stub/PipelineServiceStubSettings.java | 6 + .../stub/PredictionServiceStubSettings.java | 6 + .../v1/stub/ScheduleServiceStubSettings.java | 6 + .../SpecialistPoolServiceStubSettings.java | 6 + .../stub/TensorboardServiceStubSettings.java | 6 + .../v1/stub/VizierServiceStubSettings.java | 6 + .../v1beta1/DatasetServiceClient.java | 443 ++- .../DeploymentResourcePoolServiceClient.java | 191 +- .../v1beta1/EndpointServiceClient.java | 252 +- .../FeatureOnlineStoreAdminServiceClient.java | 347 ++- .../FeatureOnlineStoreServiceClient.java | 126 +- .../v1beta1/FeatureRegistryServiceClient.java | 291 +- ...eaturestoreOnlineServingServiceClient.java | 142 +- .../v1beta1/FeaturestoreServiceClient.java | 524 +++- .../v1beta1/IndexEndpointServiceClient.java | 250 +- .../v1beta1/IndexServiceClient.java | 219 +- .../aiplatform/v1beta1/JobServiceClient.java | 773 +++++- .../v1beta1/LlmUtilityServiceClient.java | 112 +- .../v1beta1/MatchServiceClient.java | 121 +- .../v1beta1/MetadataServiceClient.java | 711 ++++- .../v1beta1/MigrationServiceClient.java | 133 +- .../v1beta1/ModelGardenServiceClient.java | 131 +- .../v1beta1/ModelServiceClient.java | 448 ++- .../PersistentResourceServiceClient.java | 191 +- .../v1beta1/PipelineServiceClient.java | 307 ++- .../v1beta1/PredictionServiceClient.java | 245 +- .../v1beta1/ScheduleServiceClient.java | 231 +- .../v1beta1/SpecialistPoolServiceClient.java | 191 +- .../v1beta1/TensorboardServiceClient.java | 655 ++++- .../v1beta1/VizierServiceClient.java | 357 ++- .../stub/DatasetServiceStubSettings.java | 6 + ...oymentResourcePoolServiceStubSettings.java | 6 + .../stub/EndpointServiceStubSettings.java | 6 + ...reOnlineStoreAdminServiceStubSettings.java | 6 + ...FeatureOnlineStoreServiceStubSettings.java | 6 + .../FeatureRegistryServiceStubSettings.java | 6 + ...storeOnlineServingServiceStubSettings.java | 6 + .../stub/FeaturestoreServiceStubSettings.java | 6 + .../IndexEndpointServiceStubSettings.java | 6 + .../stub/IndexServiceStubSettings.java | 6 + .../v1beta1/stub/JobServiceStubSettings.java | 6 + .../stub/LlmUtilityServiceStubSettings.java | 6 + .../stub/MatchServiceStubSettings.java | 6 + .../stub/MetadataServiceStubSettings.java | 6 + .../stub/MigrationServiceStubSettings.java | 6 + .../stub/ModelGardenServiceStubSettings.java | 6 + .../stub/ModelServiceStubSettings.java | 6 + ...PersistentResourceServiceStubSettings.java | 6 + .../stub/PipelineServiceStubSettings.java | 6 + .../stub/PredictionServiceStubSettings.java | 6 + .../stub/ScheduleServiceStubSettings.java | 6 + .../SpecialistPoolServiceStubSettings.java | 6 + .../stub/TensorboardServiceStubSettings.java | 6 + .../stub/VizierServiceStubSettings.java | 6 + .../cloud/alloydb/v1/AlloyDBAdminClient.java | 646 ++++- .../v1/stub/AlloyDBAdminStubSettings.java | 6 + .../alloydb/v1alpha/AlloyDBAdminClient.java | 666 ++++- .../stub/AlloyDBAdminStubSettings.java | 6 + .../alloydb/v1beta/AlloyDBAdminClient.java | 646 ++++- .../v1beta/stub/AlloyDBAdminStubSettings.java | 6 + .../v1alpha/AnalyticsAdminServiceClient.java | 2416 ++++++++++++++++- .../AnalyticsAdminServiceStubSettings.java | 6 + .../v1beta/AnalyticsAdminServiceClient.java | 930 ++++++- .../AnalyticsAdminServiceStubSettings.java | 6 + java-analytics-data/README.md | 2 +- .../v1alpha/AlphaAnalyticsDataClient.java | 208 +- .../stub/AlphaAnalyticsDataStubSettings.java | 6 + .../data/v1beta/BetaAnalyticsDataClient.java | 216 +- .../stub/BetaAnalyticsDataStubSettings.java | 6 + java-analyticshub/README.md | 2 +- .../v1/AnalyticsHubServiceClient.java | 429 ++- .../stub/AnalyticsHubServiceStubSettings.java | 6 + java-api-gateway/README.md | 2 +- .../v1/ApiGatewayServiceClient.java | 314 ++- .../stub/ApiGatewayServiceStubSettings.java | 6 + java-apigee-connect/README.md | 2 +- .../v1/ConnectionServiceClient.java | 40 +- .../cloud/apigeeconnect/v1/TetherClient.java | 30 +- .../stub/ConnectionServiceStubSettings.java | 6 + .../v1/stub/TetherStubSettings.java | 6 + java-apigee-registry/README.md | 2 +- .../apigeeregistry/v1/ProvisioningClient.java | 152 +- .../apigeeregistry/v1/RegistryClient.java | 738 ++++- .../v1/stub/ProvisioningStubSettings.java | 6 + .../v1/stub/RegistryStubSettings.java | 6 + java-apikeys/README.md | 2 +- .../google/api/apikeys/v2/ApiKeysClient.java | 173 +- .../apikeys/v2/stub/ApiKeysStubSettings.java | 6 + java-appengine-admin/README.md | 2 +- .../appengine/v1/ApplicationsClient.java | 93 +- .../v1/AuthorizedCertificatesClient.java | 91 +- .../appengine/v1/AuthorizedDomainsClient.java | 35 +- .../appengine/v1/DomainMappingsClient.java | 94 +- .../google/appengine/v1/FirewallClient.java | 106 +- .../google/appengine/v1/InstancesClient.java | 83 +- .../google/appengine/v1/ServicesClient.java | 79 +- .../google/appengine/v1/VersionsClient.java | 127 +- .../v1/stub/ApplicationsStubSettings.java | 6 + .../AuthorizedCertificatesStubSettings.java | 6 + .../stub/AuthorizedDomainsStubSettings.java | 6 + .../v1/stub/DomainMappingsStubSettings.java | 6 + .../v1/stub/FirewallStubSettings.java | 6 + .../v1/stub/InstancesStubSettings.java | 6 + .../v1/stub/ServicesStubSettings.java | 6 + .../v1/stub/VersionsStubSettings.java | 6 + java-area120-tables/README.md | 2 +- .../tables/v1alpha/TablesServiceClient.java | 223 +- .../stub/TablesServiceStubSettings.java | 6 + java-artifact-registry/README.md | 2 +- .../v1/ArtifactRegistryClient.java | 712 ++++- .../v1/stub/ArtifactRegistryStubSettings.java | 6 + .../v1beta2/ArtifactRegistryClient.java | 495 +++- .../stub/ArtifactRegistryStubSettings.java | 6 + .../cloud/asset/v1/AssetServiceClient.java | 442 ++- .../v1/stub/AssetServiceStubSettings.java | 6 + .../asset/v1p1beta1/AssetServiceClient.java | 58 +- .../stub/AssetServiceStubSettings.java | 6 + .../asset/v1p2beta1/AssetServiceClient.java | 112 +- .../stub/AssetServiceStubSettings.java | 6 + .../asset/v1p5beta1/AssetServiceClient.java | 40 +- .../stub/AssetServiceStubSettings.java | 6 + .../asset/v1p7beta1/AssetServiceClient.java | 35 +- .../stub/AssetServiceStubSettings.java | 6 + .../BatchGetAssetsHistoryResponse.java | 2 +- ...atchGetAssetsHistoryResponseOrBuilder.java | 2 +- .../asset/v1p2beta1/ExportAssetsResponse.java | 2 +- .../ExportAssetsResponseOrBuilder.java | 2 +- java-assured-workloads/README.md | 2 +- .../v1/AssuredWorkloadsServiceClient.java | 183 +- .../AssuredWorkloadsServiceStubSettings.java | 6 + .../AssuredWorkloadsServiceClient.java | 148 +- .../AssuredWorkloadsServiceStubSettings.java | 6 + java-automl/README.md | 2 +- .../google/cloud/automl/v1/AutoMlClient.java | 381 ++- .../automl/v1/PredictionServiceClient.java | 96 +- .../automl/v1/stub/AutoMlStubSettings.java | 6 + .../stub/PredictionServiceStubSettings.java | 6 + .../cloud/automl/v1beta1/AutoMlClient.java | 501 +++- .../v1beta1/PredictionServiceClient.java | 78 +- .../v1beta1/stub/AutoMlStubSettings.java | 6 + .../stub/PredictionServiceStubSettings.java | 6 + 191 files changed, 26539 insertions(+), 1137 deletions(-) diff --git a/java-accessapproval/README.md b/java-accessapproval/README.md index 12149968badd..0e937a81c90a 100644 --- a/java-accessapproval/README.md +++ b/java-accessapproval/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-accessapproval.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-accessapproval/2.31.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-accessapproval/2.33.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java b/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java index 90e0c783d141..4e49303bac32 100644 --- a/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java +++ b/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java @@ -86,19 +86,176 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListApprovalRequests

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApprovalRequests(ListApprovalRequestsMessage request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listApprovalRequests(FolderName parent) + *
  • listApprovalRequests(OrganizationName parent) + *
  • listApprovalRequests(ProjectName parent) + *
  • listApprovalRequests(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApprovalRequestsPagedCallable() + *
  • listApprovalRequestsCallable() + *
+ *
GetApprovalRequest

Gets an approval request. Returns NOT_FOUND if the request does not exist.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApprovalRequest(GetApprovalRequestMessage request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApprovalRequest(ApprovalRequestName name) + *
  • getApprovalRequest(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApprovalRequestCallable() + *
+ *
ApproveApprovalRequest

Approves a request and returns the updated ApprovalRequest. + *

Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • approveApprovalRequest(ApproveApprovalRequestMessage request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • approveApprovalRequestCallable() + *
+ *
DismissApprovalRequest

Dismisses a request. Returns the updated ApprovalRequest. + *

NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. + *

Returns NOT_FOUND if the request does not exist. + *

Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • dismissApprovalRequest(DismissApprovalRequestMessage request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • dismissApprovalRequestCallable() + *
+ *
InvalidateApprovalRequest

Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. + *

NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. + *

Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • invalidateApprovalRequest(InvalidateApprovalRequestMessage request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • invalidateApprovalRequestCallable() + *
+ *
GetAccessApprovalSettings

Gets the settings associated with a project, folder, or organization.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAccessApprovalSettings(GetAccessApprovalSettingsMessage request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAccessApprovalSettings(AccessApprovalSettingsName name) + *
  • getAccessApprovalSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAccessApprovalSettingsCallable() + *
+ *
UpdateAccessApprovalSettings

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateAccessApprovalSettings(AccessApprovalSettings settings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAccessApprovalSettingsCallable() + *
+ *
DeleteAccessApprovalSettings

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteAccessApprovalSettings(AccessApprovalSettingsName name) + *
  • deleteAccessApprovalSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAccessApprovalSettingsCallable() + *
+ *
GetAccessApprovalServiceAccount

Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAccessApprovalServiceAccount(GetAccessApprovalServiceAccountMessage request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAccessApprovalServiceAccount(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAccessApprovalServiceAccountCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java b/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java index 6906ddd694da..f869fe9ec9a7 100644 --- a/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java +++ b/java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java @@ -272,6 +272,12 @@ public AccessApprovalStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "accessapproval"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-accesscontextmanager/README.md b/java-accesscontextmanager/README.md index 2822447be0b8..3cde5ac5dca0 100644 --- a/java-accesscontextmanager/README.md +++ b/java-accesscontextmanager/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-identity-accesscontextmanager.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-identity-accesscontextmanager/1.31.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-identity-accesscontextmanager/1.33.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/AccessContextManagerClient.java b/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/AccessContextManagerClient.java index d8ecaab362c9..e4971ed3f1fa 100644 --- a/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/AccessContextManagerClient.java +++ b/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/AccessContextManagerClient.java @@ -75,19 +75,482 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListAccessPolicies

Lists all [access policies] [google.identity.accesscontextmanager.v1.AccessPolicy] in an organization.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAccessPolicies(ListAccessPoliciesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAccessPoliciesPagedCallable() + *
  • listAccessPoliciesCallable() + *
+ *
GetAccessPolicy

Returns an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAccessPolicy(GetAccessPolicyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAccessPolicy(AccessPolicyName name) + *
  • getAccessPolicy(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAccessPolicyCallable() + *
+ *
CreateAccessPolicy

Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAccessPolicyAsync(AccessPolicy request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAccessPolicyOperationCallable() + *
  • createAccessPolicyCallable() + *
+ *
UpdateAccessPolicy

Updates an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy]. The long-running operation from this RPC has a successful status after the changes to the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] propagate to long-lasting storage.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAccessPolicyAsync(UpdateAccessPolicyRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateAccessPolicyAsync(AccessPolicy policy, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAccessPolicyOperationCallable() + *
  • updateAccessPolicyCallable() + *
+ *
DeleteAccessPolicy

Deletes an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the resource name. The long-running operation has a successful status after the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is removed from long-lasting storage.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAccessPolicyAsync(DeleteAccessPolicyRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteAccessPolicyAsync(AccessPolicyName name) + *
  • deleteAccessPolicyAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAccessPolicyOperationCallable() + *
  • deleteAccessPolicyCallable() + *
+ *
ListAccessLevels

Lists all [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] for an access policy.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAccessLevels(ListAccessLevelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAccessLevels(AccessPolicyName parent) + *
  • listAccessLevels(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAccessLevelsPagedCallable() + *
  • listAccessLevelsCallable() + *
+ *
GetAccessLevel

Gets an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAccessLevel(GetAccessLevelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAccessLevel(AccessLevelName name) + *
  • getAccessLevel(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAccessLevelCallable() + *
+ *
CreateAccessLevel

Creates an [access level] [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] propagates to long-lasting storage. If [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contain errors, an error response is returned for the first error encountered.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAccessLevelAsync(CreateAccessLevelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createAccessLevelAsync(AccessPolicyName parent, AccessLevel accessLevel) + *
  • createAccessLevelAsync(String parent, AccessLevel accessLevel) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAccessLevelOperationCallable() + *
  • createAccessLevelCallable() + *
+ *
UpdateAccessLevel

Updates an [access level] [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running operation from this RPC has a successful status after the changes to the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] propagate to long-lasting storage. If [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contain errors, an error response is returned for the first error encountered.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAccessLevelAsync(UpdateAccessLevelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateAccessLevelAsync(AccessLevel accessLevel, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAccessLevelOperationCallable() + *
  • updateAccessLevelCallable() + *
+ *
DeleteAccessLevel

Deletes an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name. The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] has been removed from long-lasting storage.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAccessLevelAsync(DeleteAccessLevelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteAccessLevelAsync(AccessLevelName name) + *
  • deleteAccessLevelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAccessLevelOperationCallable() + *
  • deleteAccessLevelCallable() + *
+ *
ReplaceAccessLevels

Replaces all existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contained in existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] result in an error.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • replaceAccessLevelsAsync(ReplaceAccessLevelsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • replaceAccessLevelsOperationCallable() + *
  • replaceAccessLevelsCallable() + *
+ *
ListServicePerimeters

Lists all [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] for an access policy.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listServicePerimeters(ListServicePerimetersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listServicePerimeters(AccessPolicyName parent) + *
  • listServicePerimeters(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listServicePerimetersPagedCallable() + *
  • listServicePerimetersCallable() + *
+ *
GetServicePerimeter

Gets a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getServicePerimeter(GetServicePerimeterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getServicePerimeter(ServicePerimeterName name) + *
  • getServicePerimeter(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getServicePerimeterCallable() + *
+ *
CreateServicePerimeter

Creates a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter]. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] propagates to long-lasting storage. If a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] contains errors, an error response is returned for the first error encountered.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createServicePerimeterAsync(CreateServicePerimeterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createServicePerimeterAsync(AccessPolicyName parent, ServicePerimeter servicePerimeter) + *
  • createServicePerimeterAsync(String parent, ServicePerimeter servicePerimeter) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createServicePerimeterOperationCallable() + *
  • createServicePerimeterCallable() + *
+ *
UpdateServicePerimeter

Updates a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter]. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] propagates to long-lasting storage. If a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] contains errors, an error response is returned for the first error encountered.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateServicePerimeterAsync(UpdateServicePerimeterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateServicePerimeterAsync(ServicePerimeter servicePerimeter, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateServicePerimeterOperationCallable() + *
  • updateServicePerimeterCallable() + *
+ *
DeleteServicePerimeter

Deletes a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] is removed from long-lasting storage.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteServicePerimeterAsync(DeleteServicePerimeterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteServicePerimeterAsync(ServicePerimeterName name) + *
  • deleteServicePerimeterAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteServicePerimeterOperationCallable() + *
  • deleteServicePerimeterCallable() + *
+ *
ReplaceServicePerimeters

Replace all existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • replaceServicePerimetersAsync(ReplaceServicePerimetersRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • replaceServicePerimetersOperationCallable() + *
  • replaceServicePerimetersCallable() + *
+ *
CommitServicePerimeters

Commits the dry-run specification for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an [access policy][google.identity.accesscontextmanager.v1.AccessPolicy]. A commit operation on a service perimeter involves copying its `spec` field to the `status` field of the service perimeter. Only [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are cleared after a successful commit operation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • commitServicePerimetersAsync(CommitServicePerimetersRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • commitServicePerimetersOperationCallable() + *
  • commitServicePerimetersCallable() + *
+ *
ListGcpUserAccessBindings

Lists all [GcpUserAccessBindings] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding] for a Google Cloud organization.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listGcpUserAccessBindings(ListGcpUserAccessBindingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listGcpUserAccessBindings(OrganizationName parent) + *
  • listGcpUserAccessBindings(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listGcpUserAccessBindingsPagedCallable() + *
  • listGcpUserAccessBindingsCallable() + *
+ *
GetGcpUserAccessBinding

Gets the [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding] with the given name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getGcpUserAccessBinding(GetGcpUserAccessBindingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getGcpUserAccessBinding(GcpUserAccessBindingName name) + *
  • getGcpUserAccessBinding(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getGcpUserAccessBindingCallable() + *
+ *
CreateGcpUserAccessBinding

Creates a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. If the client specifies a [name] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.name], the server ignores it. Fails if a resource already exists with the same [group_key] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.group_key]. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createGcpUserAccessBindingAsync(CreateGcpUserAccessBindingRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createGcpUserAccessBindingAsync(OrganizationName parent, GcpUserAccessBinding gcpUserAccessBinding) + *
  • createGcpUserAccessBindingAsync(String parent, GcpUserAccessBinding gcpUserAccessBinding) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createGcpUserAccessBindingOperationCallable() + *
  • createGcpUserAccessBindingCallable() + *
+ *
UpdateGcpUserAccessBinding

Updates a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateGcpUserAccessBindingAsync(UpdateGcpUserAccessBindingRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateGcpUserAccessBindingAsync(GcpUserAccessBinding gcpUserAccessBinding, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateGcpUserAccessBindingOperationCallable() + *
  • updateGcpUserAccessBindingCallable() + *
+ *
DeleteGcpUserAccessBinding

Deletes a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteGcpUserAccessBindingAsync(DeleteGcpUserAccessBindingRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteGcpUserAccessBindingAsync(GcpUserAccessBindingName name) + *
  • deleteGcpUserAccessBindingAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteGcpUserAccessBindingOperationCallable() + *
  • deleteGcpUserAccessBindingCallable() + *
+ *
SetIamPolicy

Sets the IAM policy for the specified Access Context Manager [access policy][google.identity.accesscontextmanager.v1.AccessPolicy]. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager [access policy][google.identity.accesscontextmanager.v1.AccessPolicy].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the IAM policy for the specified Access Context Manager [access policy][google.identity.accesscontextmanager.v1.AccessPolicy].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an [AccessPolicy][google.identity.accesscontextmanager.v1.AccessPolicy], [AccessLevel][google.identity.accesscontextmanager.v1.AccessLevel], or [ServicePerimeter][google.identity.accesscontextmanager.v1.ServicePerimeter ]. This method does not support other resources.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/stub/AccessContextManagerStubSettings.java b/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/stub/AccessContextManagerStubSettings.java index d4169d0e49ec..12201deadd3e 100644 --- a/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/stub/AccessContextManagerStubSettings.java +++ b/java-accesscontextmanager/google-identity-accesscontextmanager/src/main/java/com/google/identity/accesscontextmanager/v1/stub/AccessContextManagerStubSettings.java @@ -796,6 +796,12 @@ public AccessContextManagerStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "accesscontextmanager"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-advisorynotifications/README.md b/java-advisorynotifications/README.md index 94a1f9710941..e2b48257196b 100644 --- a/java-advisorynotifications/README.md +++ b/java-advisorynotifications/README.md @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-advisorynotifications/java11.html [stability-image]: https://img.shields.io/badge/stability-preview-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-advisorynotifications.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-advisorynotifications/0.20.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-advisorynotifications/0.21.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/AdvisoryNotificationsServiceClient.java b/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/AdvisoryNotificationsServiceClient.java index 74c581ce082c..84f58a48ec87 100644 --- a/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/AdvisoryNotificationsServiceClient.java +++ b/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/AdvisoryNotificationsServiceClient.java @@ -58,19 +58,89 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListNotifications

Lists notifications under a given parent.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listNotifications(ListNotificationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listNotifications(LocationName parent) + *
  • listNotifications(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listNotificationsPagedCallable() + *
  • listNotificationsCallable() + *
+ *
GetNotification

Gets a notification.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getNotification(GetNotificationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getNotification(NotificationName name) + *
  • getNotification(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getNotificationCallable() + *
+ *
GetSettings

Get notification settings.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSettings(GetSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSettings(SettingsName name) + *
  • getSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSettingsCallable() + *
+ *
UpdateSettings

Update notification settings.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSettings(UpdateSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateSettings(Settings settings) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateSettingsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/stub/AdvisoryNotificationsServiceStubSettings.java b/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/stub/AdvisoryNotificationsServiceStubSettings.java index 38a47486894d..44f64dea7fef 100644 --- a/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/stub/AdvisoryNotificationsServiceStubSettings.java +++ b/java-advisorynotifications/google-cloud-advisorynotifications/src/main/java/com/google/cloud/advisorynotifications/v1/stub/AdvisoryNotificationsServiceStubSettings.java @@ -211,6 +211,12 @@ public AdvisoryNotificationsServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "advisorynotifications"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/README.md b/java-aiplatform/README.md index cb6acc92f7fb..b62dc9c515d3 100644 --- a/java-aiplatform/README.md +++ b/java-aiplatform/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-aiplatform.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-aiplatform/3.32.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-aiplatform/3.33.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DatasetServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DatasetServiceClient.java index ce4299d9ae14..3eacceaad010 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DatasetServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DatasetServiceClient.java @@ -69,19 +69,436 @@ *

Note: close() needs to be called on the DatasetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateDataset

Creates a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDatasetAsync(CreateDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createDatasetAsync(LocationName parent, Dataset dataset) + *
  • createDatasetAsync(String parent, Dataset dataset) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDatasetOperationCallable() + *
  • createDatasetCallable() + *
+ *
GetDataset

Gets a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataset(GetDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataset(DatasetName name) + *
  • getDataset(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDatasetCallable() + *
+ *
UpdateDataset

Updates a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataset(UpdateDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataset(Dataset dataset, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDatasetCallable() + *
+ *
ListDatasets

Lists Datasets in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDatasets(ListDatasetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDatasets(LocationName parent) + *
  • listDatasets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDatasetsPagedCallable() + *
  • listDatasetsCallable() + *
+ *
DeleteDataset

Deletes a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDatasetAsync(DeleteDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDatasetAsync(DatasetName name) + *
  • deleteDatasetAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDatasetOperationCallable() + *
  • deleteDatasetCallable() + *
+ *
ImportData

Imports data into a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importDataAsync(ImportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • importDataAsync(DatasetName name, List importConfigs) + *
  • importDataAsync(String name, List importConfigs) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importDataOperationCallable() + *
  • importDataCallable() + *
+ *
ExportData

Exports data from a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportDataAsync(ExportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportDataAsync(DatasetName name, ExportDataConfig exportConfig) + *
  • exportDataAsync(String name, ExportDataConfig exportConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportDataOperationCallable() + *
  • exportDataCallable() + *
+ *
CreateDatasetVersion

Create a version from a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDatasetVersionAsync(CreateDatasetVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createDatasetVersionAsync(DatasetName parent, DatasetVersion datasetVersion) + *
  • createDatasetVersionAsync(String parent, DatasetVersion datasetVersion) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDatasetVersionOperationCallable() + *
  • createDatasetVersionCallable() + *
+ *
DeleteDatasetVersion

Deletes a Dataset version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDatasetVersionAsync(DeleteDatasetVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDatasetVersionAsync(DatasetVersionName name) + *
  • deleteDatasetVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDatasetVersionOperationCallable() + *
  • deleteDatasetVersionCallable() + *
+ *
GetDatasetVersion

Gets a Dataset version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDatasetVersion(GetDatasetVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDatasetVersion(DatasetVersionName name) + *
  • getDatasetVersion(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDatasetVersionCallable() + *
+ *
ListDatasetVersions

Lists DatasetVersions in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDatasetVersions(ListDatasetVersionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDatasetVersions(DatasetName parent) + *
  • listDatasetVersions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDatasetVersionsPagedCallable() + *
  • listDatasetVersionsCallable() + *
+ *
RestoreDatasetVersion

Restores a dataset version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restoreDatasetVersionAsync(RestoreDatasetVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • restoreDatasetVersionAsync(DatasetVersionName name) + *
  • restoreDatasetVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restoreDatasetVersionOperationCallable() + *
  • restoreDatasetVersionCallable() + *
+ *
ListDataItems

Lists DataItems in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDataItems(ListDataItemsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDataItems(DatasetName parent) + *
  • listDataItems(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDataItemsPagedCallable() + *
  • listDataItemsCallable() + *
+ *
SearchDataItems

Searches DataItems in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchDataItems(SearchDataItemsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchDataItemsPagedCallable() + *
  • searchDataItemsCallable() + *
+ *
ListSavedQueries

Lists SavedQueries in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSavedQueries(ListSavedQueriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSavedQueries(DatasetName parent) + *
  • listSavedQueries(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSavedQueriesPagedCallable() + *
  • listSavedQueriesCallable() + *
+ *
DeleteSavedQuery

Deletes a SavedQuery.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSavedQueryAsync(DeleteSavedQueryRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteSavedQueryAsync(SavedQueryName name) + *
  • deleteSavedQueryAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSavedQueryOperationCallable() + *
  • deleteSavedQueryCallable() + *
+ *
GetAnnotationSpec

Gets an AnnotationSpec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAnnotationSpec(GetAnnotationSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAnnotationSpec(AnnotationSpecName name) + *
  • getAnnotationSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAnnotationSpecCallable() + *
+ *
ListAnnotations

Lists Annotations belongs to a dataitem

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAnnotations(ListAnnotationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAnnotations(DataItemName parent) + *
  • listAnnotations(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAnnotationsPagedCallable() + *
  • listAnnotationsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DeploymentResourcePoolServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DeploymentResourcePoolServiceClient.java index 3a562446ee67..bf7988757ea2 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DeploymentResourcePoolServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/DeploymentResourcePoolServiceClient.java @@ -72,19 +72,184 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateDeploymentResourcePool

Create a DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDeploymentResourcePoolAsync(CreateDeploymentResourcePoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createDeploymentResourcePoolAsync(LocationName parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId) + *
  • createDeploymentResourcePoolAsync(String parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDeploymentResourcePoolOperationCallable() + *
  • createDeploymentResourcePoolCallable() + *
+ *
GetDeploymentResourcePool

Get a DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDeploymentResourcePool(GetDeploymentResourcePoolRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDeploymentResourcePool(DeploymentResourcePoolName name) + *
  • getDeploymentResourcePool(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDeploymentResourcePoolCallable() + *
+ *
ListDeploymentResourcePools

List DeploymentResourcePools in a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDeploymentResourcePools(ListDeploymentResourcePoolsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDeploymentResourcePools(ProjectName parent) + *
  • listDeploymentResourcePools(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDeploymentResourcePoolsPagedCallable() + *
  • listDeploymentResourcePoolsCallable() + *
+ *
DeleteDeploymentResourcePool

Delete a DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDeploymentResourcePoolAsync(DeleteDeploymentResourcePoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDeploymentResourcePoolAsync(DeploymentResourcePoolName name) + *
  • deleteDeploymentResourcePoolAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDeploymentResourcePoolOperationCallable() + *
  • deleteDeploymentResourcePoolCallable() + *
+ *
QueryDeployedModels

List DeployedModels that have been deployed on this DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryDeployedModels(QueryDeployedModelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryDeployedModels(String deploymentResourcePool) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryDeployedModelsPagedCallable() + *
  • queryDeployedModelsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/EndpointServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/EndpointServiceClient.java index 7d1817366384..629f04db5a39 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/EndpointServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/EndpointServiceClient.java @@ -72,19 +72,245 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateEndpoint

Creates an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createEndpointAsync(CreateEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createEndpointAsync(LocationName parent, Endpoint endpoint) + *
  • createEndpointAsync(String parent, Endpoint endpoint) + *
  • createEndpointAsync(LocationName parent, Endpoint endpoint, String endpointId) + *
  • createEndpointAsync(String parent, Endpoint endpoint, String endpointId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createEndpointOperationCallable() + *
  • createEndpointCallable() + *
+ *
GetEndpoint

Gets an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getEndpoint(GetEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getEndpoint(EndpointName name) + *
  • getEndpoint(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getEndpointCallable() + *
+ *
ListEndpoints

Lists Endpoints in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listEndpoints(ListEndpointsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listEndpoints(LocationName parent) + *
  • listEndpoints(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listEndpointsPagedCallable() + *
  • listEndpointsCallable() + *
+ *
UpdateEndpoint

Updates an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateEndpoint(UpdateEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateEndpoint(Endpoint endpoint, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateEndpointCallable() + *
+ *
DeleteEndpoint

Deletes an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteEndpointAsync(DeleteEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteEndpointAsync(EndpointName name) + *
  • deleteEndpointAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteEndpointOperationCallable() + *
  • deleteEndpointCallable() + *
+ *
DeployModel

Deploys a Model into this Endpoint, creating a DeployedModel within it.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deployModelAsync(DeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deployModelAsync(EndpointName endpoint, DeployedModel deployedModel, Map trafficSplit) + *
  • deployModelAsync(String endpoint, DeployedModel deployedModel, Map trafficSplit) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deployModelOperationCallable() + *
  • deployModelCallable() + *
+ *
UndeployModel

Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • undeployModelAsync(UndeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • undeployModelAsync(EndpointName endpoint, String deployedModelId, Map trafficSplit) + *
  • undeployModelAsync(String endpoint, String deployedModelId, Map trafficSplit) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • undeployModelOperationCallable() + *
  • undeployModelCallable() + *
+ *
MutateDeployedModel

Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • mutateDeployedModelAsync(MutateDeployedModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • mutateDeployedModelAsync(EndpointName endpoint, DeployedModel deployedModel, FieldMask updateMask) + *
  • mutateDeployedModelAsync(String endpoint, DeployedModel deployedModel, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • mutateDeployedModelOperationCallable() + *
  • mutateDeployedModelCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreAdminServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreAdminServiceClient.java index 9c741e5d1cdd..8ce099cf1d68 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreAdminServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreAdminServiceClient.java @@ -73,19 +73,340 @@ * up resources such as threads. In the example above, try-with-resources is used, which * automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateFeatureOnlineStore

Creates a new FeatureOnlineStore in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureOnlineStoreAsync(CreateFeatureOnlineStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureOnlineStoreAsync(LocationName parent, FeatureOnlineStore featureOnlineStore, String featureOnlineStoreId) + *
  • createFeatureOnlineStoreAsync(String parent, FeatureOnlineStore featureOnlineStore, String featureOnlineStoreId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureOnlineStoreOperationCallable() + *
  • createFeatureOnlineStoreCallable() + *
+ *
GetFeatureOnlineStore

Gets details of a single FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureOnlineStore(GetFeatureOnlineStoreRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureOnlineStore(FeatureOnlineStoreName name) + *
  • getFeatureOnlineStore(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureOnlineStoreCallable() + *
+ *
ListFeatureOnlineStores

Lists FeatureOnlineStores in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureOnlineStores(ListFeatureOnlineStoresRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureOnlineStores(LocationName parent) + *
  • listFeatureOnlineStores(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureOnlineStoresPagedCallable() + *
  • listFeatureOnlineStoresCallable() + *
+ *
UpdateFeatureOnlineStore

Updates the parameters of a single FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureOnlineStoreAsync(UpdateFeatureOnlineStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureOnlineStoreAsync(FeatureOnlineStore featureOnlineStore, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureOnlineStoreOperationCallable() + *
  • updateFeatureOnlineStoreCallable() + *
+ *
DeleteFeatureOnlineStore

Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureOnlineStoreAsync(DeleteFeatureOnlineStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureOnlineStoreAsync(FeatureOnlineStoreName name, boolean force) + *
  • deleteFeatureOnlineStoreAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureOnlineStoreOperationCallable() + *
  • deleteFeatureOnlineStoreCallable() + *
+ *
CreateFeatureView

Creates a new FeatureView in a given FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureViewAsync(CreateFeatureViewRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureViewAsync(FeatureOnlineStoreName parent, FeatureView featureView, String featureViewId) + *
  • createFeatureViewAsync(String parent, FeatureView featureView, String featureViewId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureViewOperationCallable() + *
  • createFeatureViewCallable() + *
+ *
GetFeatureView

Gets details of a single FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureView(GetFeatureViewRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureView(FeatureViewName name) + *
  • getFeatureView(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureViewCallable() + *
+ *
ListFeatureViews

Lists FeatureViews in a given FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureViews(ListFeatureViewsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureViews(FeatureOnlineStoreName parent) + *
  • listFeatureViews(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureViewsPagedCallable() + *
  • listFeatureViewsCallable() + *
+ *
UpdateFeatureView

Updates the parameters of a single FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureViewAsync(UpdateFeatureViewRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureViewAsync(FeatureView featureView, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureViewOperationCallable() + *
  • updateFeatureViewCallable() + *
+ *
DeleteFeatureView

Deletes a single FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureViewAsync(DeleteFeatureViewRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureViewAsync(FeatureViewName name) + *
  • deleteFeatureViewAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureViewOperationCallable() + *
  • deleteFeatureViewCallable() + *
+ *
SyncFeatureView

Triggers on-demand sync for the FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • syncFeatureView(SyncFeatureViewRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • syncFeatureView(FeatureViewName featureView) + *
  • syncFeatureView(String featureView) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • syncFeatureViewCallable() + *
+ *
GetFeatureViewSync

Gets details of a single FeatureViewSync.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureViewSync(GetFeatureViewSyncRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureViewSync(FeatureViewSyncName name) + *
  • getFeatureViewSync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureViewSyncCallable() + *
+ *
ListFeatureViewSyncs

Lists FeatureViewSyncs in a given FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureViewSyncs(ListFeatureViewSyncsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureViewSyncs(FeatureViewName parent) + *
  • listFeatureViewSyncs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureViewSyncsPagedCallable() + *
  • listFeatureViewSyncsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreServiceClient.java index eb528e8fb0ce..a62c6decbe96 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureOnlineStoreServiceClient.java @@ -66,19 +66,105 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
FetchFeatureValues

Fetch feature values under a FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • fetchFeatureValues(FetchFeatureValuesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • fetchFeatureValues(FeatureViewName featureView, FeatureViewDataKey dataKey) + *
  • fetchFeatureValues(String featureView, FeatureViewDataKey dataKey) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • fetchFeatureValuesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureRegistryServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureRegistryServiceClient.java index 454f060064b6..c8403b0594df 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureRegistryServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeatureRegistryServiceClient.java @@ -71,19 +71,284 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateFeatureGroup

Creates a new FeatureGroup in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureGroupAsync(CreateFeatureGroupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureGroupAsync(LocationName parent, FeatureGroup featureGroup, String featureGroupId) + *
  • createFeatureGroupAsync(String parent, FeatureGroup featureGroup, String featureGroupId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureGroupOperationCallable() + *
  • createFeatureGroupCallable() + *
+ *
GetFeatureGroup

Gets details of a single FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureGroup(GetFeatureGroupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureGroup(FeatureGroupName name) + *
  • getFeatureGroup(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureGroupCallable() + *
+ *
ListFeatureGroups

Lists FeatureGroups in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureGroups(ListFeatureGroupsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureGroups(LocationName parent) + *
  • listFeatureGroups(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureGroupsPagedCallable() + *
  • listFeatureGroupsCallable() + *
+ *
UpdateFeatureGroup

Updates the parameters of a single FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureGroupAsync(UpdateFeatureGroupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureGroupAsync(FeatureGroup featureGroup, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureGroupOperationCallable() + *
  • updateFeatureGroupCallable() + *
+ *
DeleteFeatureGroup

Deletes a single FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureGroupAsync(DeleteFeatureGroupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureGroupAsync(FeatureGroupName name, boolean force) + *
  • deleteFeatureGroupAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureGroupOperationCallable() + *
  • deleteFeatureGroupCallable() + *
+ *
CreateFeature

Creates a new Feature in a given FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureAsync(CreateFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureAsync(EntityTypeName parent, Feature feature, String featureId) + *
  • createFeatureAsync(FeatureGroupName parent, Feature feature, String featureId) + *
  • createFeatureAsync(String parent, Feature feature, String featureId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureOperationCallable() + *
  • createFeatureCallable() + *
+ *
GetFeature

Gets details of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeature(GetFeatureRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeature(FeatureName name) + *
  • getFeature(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureCallable() + *
+ *
ListFeatures

Lists Features in a given FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatures(ListFeaturesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatures(EntityTypeName parent) + *
  • listFeatures(FeatureGroupName parent) + *
  • listFeatures(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeaturesPagedCallable() + *
  • listFeaturesCallable() + *
+ *
UpdateFeature

Updates the parameters of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureAsync(UpdateFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureAsync(Feature feature, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureOperationCallable() + *
  • updateFeatureCallable() + *
+ *
DeleteFeature

Deletes a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureAsync(DeleteFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureAsync(FeatureName name) + *
  • deleteFeatureAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureOperationCallable() + *
  • deleteFeatureCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreOnlineServingServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreOnlineServingServiceClient.java index a8f4bba7bec6..0a07a07d69a7 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreOnlineServingServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreOnlineServingServiceClient.java @@ -68,19 +68,135 @@ * up resources such as threads. In the example above, try-with-resources is used, which * automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ReadFeatureValues

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readFeatureValues(ReadFeatureValuesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readFeatureValues(EntityTypeName entityType) + *
  • readFeatureValues(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readFeatureValuesCallable() + *
+ *
StreamingReadFeatureValues

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamingReadFeatureValuesCallable() + *
+ *
WriteFeatureValues

Writes Feature values of one or more entities of an EntityType. + *

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • writeFeatureValues(WriteFeatureValuesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • writeFeatureValues(EntityTypeName entityType, List payloads) + *
  • writeFeatureValues(String entityType, List payloads) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • writeFeatureValuesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreServiceClient.java index 0e3966e54acc..3e082f4157a7 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/FeaturestoreServiceClient.java @@ -70,19 +70,517 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateFeaturestore

Creates a new Featurestore in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeaturestoreAsync(CreateFeaturestoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeaturestoreAsync(LocationName parent, Featurestore featurestore) + *
  • createFeaturestoreAsync(String parent, Featurestore featurestore) + *
  • createFeaturestoreAsync(LocationName parent, Featurestore featurestore, String featurestoreId) + *
  • createFeaturestoreAsync(String parent, Featurestore featurestore, String featurestoreId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeaturestoreOperationCallable() + *
  • createFeaturestoreCallable() + *
+ *
GetFeaturestore

Gets details of a single Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeaturestore(GetFeaturestoreRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeaturestore(FeaturestoreName name) + *
  • getFeaturestore(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeaturestoreCallable() + *
+ *
ListFeaturestores

Lists Featurestores in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeaturestores(ListFeaturestoresRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeaturestores(LocationName parent) + *
  • listFeaturestores(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeaturestoresPagedCallable() + *
  • listFeaturestoresCallable() + *
+ *
UpdateFeaturestore

Updates the parameters of a single Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeaturestoreAsync(UpdateFeaturestoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeaturestoreAsync(Featurestore featurestore, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeaturestoreOperationCallable() + *
  • updateFeaturestoreCallable() + *
+ *
DeleteFeaturestore

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeaturestoreAsync(DeleteFeaturestoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeaturestoreAsync(FeaturestoreName name) + *
  • deleteFeaturestoreAsync(String name) + *
  • deleteFeaturestoreAsync(FeaturestoreName name, boolean force) + *
  • deleteFeaturestoreAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeaturestoreOperationCallable() + *
  • deleteFeaturestoreCallable() + *
+ *
CreateEntityType

Creates a new EntityType in a given Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createEntityTypeAsync(CreateEntityTypeRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createEntityTypeAsync(FeaturestoreName parent, EntityType entityType) + *
  • createEntityTypeAsync(String parent, EntityType entityType) + *
  • createEntityTypeAsync(FeaturestoreName parent, EntityType entityType, String entityTypeId) + *
  • createEntityTypeAsync(String parent, EntityType entityType, String entityTypeId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createEntityTypeOperationCallable() + *
  • createEntityTypeCallable() + *
+ *
GetEntityType

Gets details of a single EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getEntityType(GetEntityTypeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getEntityType(EntityTypeName name) + *
  • getEntityType(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getEntityTypeCallable() + *
+ *
ListEntityTypes

Lists EntityTypes in a given Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listEntityTypes(ListEntityTypesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listEntityTypes(FeaturestoreName parent) + *
  • listEntityTypes(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listEntityTypesPagedCallable() + *
  • listEntityTypesCallable() + *
+ *
UpdateEntityType

Updates the parameters of a single EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateEntityType(UpdateEntityTypeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateEntityType(EntityType entityType, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateEntityTypeCallable() + *
+ *
DeleteEntityType

Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteEntityTypeAsync(DeleteEntityTypeRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteEntityTypeAsync(EntityTypeName name) + *
  • deleteEntityTypeAsync(String name) + *
  • deleteEntityTypeAsync(EntityTypeName name, boolean force) + *
  • deleteEntityTypeAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteEntityTypeOperationCallable() + *
  • deleteEntityTypeCallable() + *
+ *
CreateFeature

Creates a new Feature in a given EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureAsync(CreateFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureAsync(EntityTypeName parent, Feature feature) + *
  • createFeatureAsync(FeatureGroupName parent, Feature feature) + *
  • createFeatureAsync(String parent, Feature feature) + *
  • createFeatureAsync(EntityTypeName parent, Feature feature, String featureId) + *
  • createFeatureAsync(FeatureGroupName parent, Feature feature, String featureId) + *
  • createFeatureAsync(String parent, Feature feature, String featureId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureOperationCallable() + *
  • createFeatureCallable() + *
+ *
BatchCreateFeatures

Creates a batch of Features in a given EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateFeaturesAsync(EntityTypeName parent, List requests) + *
  • batchCreateFeaturesAsync(String parent, List requests) + *
  • batchCreateFeaturesAsync(BatchCreateFeaturesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateFeaturesOperationCallable() + *
  • batchCreateFeaturesCallable() + *
+ *
GetFeature

Gets details of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeature(GetFeatureRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeature(FeatureName name) + *
  • getFeature(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureCallable() + *
+ *
ListFeatures

Lists Features in a given EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatures(ListFeaturesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatures(EntityTypeName parent) + *
  • listFeatures(FeatureGroupName parent) + *
  • listFeatures(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeaturesPagedCallable() + *
  • listFeaturesCallable() + *
+ *
UpdateFeature

Updates the parameters of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeature(UpdateFeatureRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateFeature(Feature feature, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureCallable() + *
+ *
DeleteFeature

Deletes a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureAsync(DeleteFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureAsync(FeatureName name) + *
  • deleteFeatureAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureOperationCallable() + *
  • deleteFeatureCallable() + *
+ *
ImportFeatureValues

Imports Feature values into the Featurestore from a source storage. + *

The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. + *

If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. + *

There are also scenarios where the caller can cause inconsistency. + *

- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importFeatureValuesAsync(ImportFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • importFeatureValuesAsync(EntityTypeName entityType) + *
  • importFeatureValuesAsync(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importFeatureValuesOperationCallable() + *
  • importFeatureValuesCallable() + *
+ *
BatchReadFeatureValues

Batch reads Feature values from a Featurestore. + *

This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchReadFeatureValuesAsync(BatchReadFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchReadFeatureValuesAsync(FeaturestoreName featurestore) + *
  • batchReadFeatureValuesAsync(String featurestore) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchReadFeatureValuesOperationCallable() + *
  • batchReadFeatureValuesCallable() + *
+ *
ExportFeatureValues

Exports Feature values from all the entities of a target EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportFeatureValuesAsync(ExportFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportFeatureValuesAsync(EntityTypeName entityType) + *
  • exportFeatureValuesAsync(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportFeatureValuesOperationCallable() + *
  • exportFeatureValuesCallable() + *
+ *
DeleteFeatureValues

Delete Feature values from Featurestore. + *

The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. + *

If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureValuesAsync(DeleteFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureValuesAsync(EntityTypeName entityType) + *
  • deleteFeatureValuesAsync(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureValuesOperationCallable() + *
  • deleteFeatureValuesCallable() + *
+ *
SearchFeatures

Searches Features matching a query in a given project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchFeatures(SearchFeaturesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchFeatures(LocationName location) + *
  • searchFeatures(String location) + *
  • searchFeatures(LocationName location, String query) + *
  • searchFeatures(String location, String query) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchFeaturesPagedCallable() + *
  • searchFeaturesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexEndpointServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexEndpointServiceClient.java index 7665c8d68ecf..77a1f9c70dfb 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexEndpointServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexEndpointServiceClient.java @@ -71,19 +71,243 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateIndexEndpoint

Creates an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createIndexEndpointAsync(CreateIndexEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createIndexEndpointAsync(LocationName parent, IndexEndpoint indexEndpoint) + *
  • createIndexEndpointAsync(String parent, IndexEndpoint indexEndpoint) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createIndexEndpointOperationCallable() + *
  • createIndexEndpointCallable() + *
+ *
GetIndexEndpoint

Gets an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIndexEndpoint(GetIndexEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getIndexEndpoint(IndexEndpointName name) + *
  • getIndexEndpoint(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIndexEndpointCallable() + *
+ *
ListIndexEndpoints

Lists IndexEndpoints in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listIndexEndpoints(ListIndexEndpointsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listIndexEndpoints(LocationName parent) + *
  • listIndexEndpoints(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listIndexEndpointsPagedCallable() + *
  • listIndexEndpointsCallable() + *
+ *
UpdateIndexEndpoint

Updates an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateIndexEndpoint(UpdateIndexEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateIndexEndpoint(IndexEndpoint indexEndpoint, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateIndexEndpointCallable() + *
+ *
DeleteIndexEndpoint

Deletes an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteIndexEndpointAsync(DeleteIndexEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteIndexEndpointAsync(IndexEndpointName name) + *
  • deleteIndexEndpointAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteIndexEndpointOperationCallable() + *
  • deleteIndexEndpointCallable() + *
+ *
DeployIndex

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deployIndexAsync(DeployIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deployIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex) + *
  • deployIndexAsync(String indexEndpoint, DeployedIndex deployedIndex) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deployIndexOperationCallable() + *
  • deployIndexCallable() + *
+ *
UndeployIndex

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • undeployIndexAsync(UndeployIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • undeployIndexAsync(IndexEndpointName indexEndpoint, String deployedIndexId) + *
  • undeployIndexAsync(String indexEndpoint, String deployedIndexId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • undeployIndexOperationCallable() + *
  • undeployIndexCallable() + *
+ *
MutateDeployedIndex

Update an existing DeployedIndex under an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • mutateDeployedIndexAsync(MutateDeployedIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • mutateDeployedIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex) + *
  • mutateDeployedIndexAsync(String indexEndpoint, DeployedIndex deployedIndex) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • mutateDeployedIndexOperationCallable() + *
  • mutateDeployedIndexCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexServiceClient.java index 63082d26a9f3..0f512f9e68e0 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/IndexServiceClient.java @@ -69,19 +69,212 @@ *

Note: close() needs to be called on the IndexServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateIndex

Creates an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createIndexAsync(CreateIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createIndexAsync(LocationName parent, Index index) + *
  • createIndexAsync(String parent, Index index) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createIndexOperationCallable() + *
  • createIndexCallable() + *
+ *
GetIndex

Gets an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIndex(GetIndexRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getIndex(IndexName name) + *
  • getIndex(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIndexCallable() + *
+ *
ListIndexes

Lists Indexes in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listIndexes(ListIndexesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listIndexes(LocationName parent) + *
  • listIndexes(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listIndexesPagedCallable() + *
  • listIndexesCallable() + *
+ *
UpdateIndex

Updates an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateIndexAsync(UpdateIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateIndexAsync(Index index, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateIndexOperationCallable() + *
  • updateIndexCallable() + *
+ *
DeleteIndex

Deletes an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had been undeployed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteIndexAsync(DeleteIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteIndexAsync(IndexName name) + *
  • deleteIndexAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteIndexOperationCallable() + *
  • deleteIndexCallable() + *
+ *
UpsertDatapoints

Add/update Datapoints into an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • upsertDatapoints(UpsertDatapointsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • upsertDatapointsCallable() + *
+ *
RemoveDatapoints

Remove Datapoints from an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • removeDatapoints(RemoveDatapointsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • removeDatapointsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/JobServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/JobServiceClient.java index 18dc849d5478..a70bf788c41f 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/JobServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/JobServiceClient.java @@ -70,19 +70,766 @@ *

Note: close() needs to be called on the JobServiceClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateCustomJob

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createCustomJob(CreateCustomJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createCustomJob(LocationName parent, CustomJob customJob) + *
  • createCustomJob(String parent, CustomJob customJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createCustomJobCallable() + *
+ *
GetCustomJob

Gets a CustomJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCustomJob(GetCustomJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCustomJob(CustomJobName name) + *
  • getCustomJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getCustomJobCallable() + *
+ *
ListCustomJobs

Lists CustomJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listCustomJobs(ListCustomJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listCustomJobs(LocationName parent) + *
  • listCustomJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listCustomJobsPagedCallable() + *
  • listCustomJobsCallable() + *
+ *
DeleteCustomJob

Deletes a CustomJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteCustomJobAsync(DeleteCustomJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteCustomJobAsync(CustomJobName name) + *
  • deleteCustomJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteCustomJobOperationCallable() + *
  • deleteCustomJobCallable() + *
+ *
CancelCustomJob

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelCustomJob(CancelCustomJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelCustomJob(CustomJobName name) + *
  • cancelCustomJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelCustomJobCallable() + *
+ *
CreateDataLabelingJob

Creates a DataLabelingJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDataLabelingJob(CreateDataLabelingJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDataLabelingJob(LocationName parent, DataLabelingJob dataLabelingJob) + *
  • createDataLabelingJob(String parent, DataLabelingJob dataLabelingJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDataLabelingJobCallable() + *
+ *
GetDataLabelingJob

Gets a DataLabelingJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataLabelingJob(GetDataLabelingJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataLabelingJob(DataLabelingJobName name) + *
  • getDataLabelingJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataLabelingJobCallable() + *
+ *
ListDataLabelingJobs

Lists DataLabelingJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDataLabelingJobs(ListDataLabelingJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDataLabelingJobs(LocationName parent) + *
  • listDataLabelingJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDataLabelingJobsPagedCallable() + *
  • listDataLabelingJobsCallable() + *
+ *
DeleteDataLabelingJob

Deletes a DataLabelingJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDataLabelingJobAsync(DataLabelingJobName name) + *
  • deleteDataLabelingJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDataLabelingJobOperationCallable() + *
  • deleteDataLabelingJobCallable() + *
+ *
CancelDataLabelingJob

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelDataLabelingJob(CancelDataLabelingJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelDataLabelingJob(DataLabelingJobName name) + *
  • cancelDataLabelingJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelDataLabelingJobCallable() + *
+ *
CreateHyperparameterTuningJob

Creates a HyperparameterTuningJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createHyperparameterTuningJob(LocationName parent, HyperparameterTuningJob hyperparameterTuningJob) + *
  • createHyperparameterTuningJob(String parent, HyperparameterTuningJob hyperparameterTuningJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createHyperparameterTuningJobCallable() + *
+ *
GetHyperparameterTuningJob

Gets a HyperparameterTuningJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getHyperparameterTuningJob(HyperparameterTuningJobName name) + *
  • getHyperparameterTuningJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getHyperparameterTuningJobCallable() + *
+ *
ListHyperparameterTuningJobs

Lists HyperparameterTuningJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listHyperparameterTuningJobs(LocationName parent) + *
  • listHyperparameterTuningJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listHyperparameterTuningJobsPagedCallable() + *
  • listHyperparameterTuningJobsCallable() + *
+ *
DeleteHyperparameterTuningJob

Deletes a HyperparameterTuningJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteHyperparameterTuningJobAsync(HyperparameterTuningJobName name) + *
  • deleteHyperparameterTuningJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteHyperparameterTuningJobOperationCallable() + *
  • deleteHyperparameterTuningJobCallable() + *
+ *
CancelHyperparameterTuningJob

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelHyperparameterTuningJob(HyperparameterTuningJobName name) + *
  • cancelHyperparameterTuningJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelHyperparameterTuningJobCallable() + *
+ *
CreateNasJob

Creates a NasJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createNasJob(CreateNasJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createNasJob(LocationName parent, NasJob nasJob) + *
  • createNasJob(String parent, NasJob nasJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createNasJobCallable() + *
+ *
GetNasJob

Gets a NasJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getNasJob(GetNasJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getNasJob(NasJobName name) + *
  • getNasJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getNasJobCallable() + *
+ *
ListNasJobs

Lists NasJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listNasJobs(ListNasJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listNasJobs(LocationName parent) + *
  • listNasJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listNasJobsPagedCallable() + *
  • listNasJobsCallable() + *
+ *
DeleteNasJob

Deletes a NasJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteNasJobAsync(DeleteNasJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteNasJobAsync(NasJobName name) + *
  • deleteNasJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteNasJobOperationCallable() + *
  • deleteNasJobCallable() + *
+ *
CancelNasJob

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelNasJob(CancelNasJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelNasJob(NasJobName name) + *
  • cancelNasJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelNasJobCallable() + *
+ *
GetNasTrialDetail

Gets a NasTrialDetail.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getNasTrialDetail(GetNasTrialDetailRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getNasTrialDetail(NasTrialDetailName name) + *
  • getNasTrialDetail(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getNasTrialDetailCallable() + *
+ *
ListNasTrialDetails

List top NasTrialDetails of a NasJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listNasTrialDetails(ListNasTrialDetailsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listNasTrialDetails(NasJobName parent) + *
  • listNasTrialDetails(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listNasTrialDetailsPagedCallable() + *
  • listNasTrialDetailsCallable() + *
+ *
CreateBatchPredictionJob

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createBatchPredictionJob(CreateBatchPredictionJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createBatchPredictionJob(LocationName parent, BatchPredictionJob batchPredictionJob) + *
  • createBatchPredictionJob(String parent, BatchPredictionJob batchPredictionJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createBatchPredictionJobCallable() + *
+ *
GetBatchPredictionJob

Gets a BatchPredictionJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getBatchPredictionJob(GetBatchPredictionJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getBatchPredictionJob(BatchPredictionJobName name) + *
  • getBatchPredictionJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getBatchPredictionJobCallable() + *
+ *
ListBatchPredictionJobs

Lists BatchPredictionJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listBatchPredictionJobs(ListBatchPredictionJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listBatchPredictionJobs(LocationName parent) + *
  • listBatchPredictionJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listBatchPredictionJobsPagedCallable() + *
  • listBatchPredictionJobsCallable() + *
+ *
DeleteBatchPredictionJob

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteBatchPredictionJobAsync(BatchPredictionJobName name) + *
  • deleteBatchPredictionJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteBatchPredictionJobOperationCallable() + *
  • deleteBatchPredictionJobCallable() + *
+ *
CancelBatchPredictionJob

Cancels a BatchPredictionJob. + *

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelBatchPredictionJob(CancelBatchPredictionJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelBatchPredictionJob(BatchPredictionJobName name) + *
  • cancelBatchPredictionJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelBatchPredictionJobCallable() + *
+ *
CreateModelDeploymentMonitoringJob

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createModelDeploymentMonitoringJob(LocationName parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob) + *
  • createModelDeploymentMonitoringJob(String parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createModelDeploymentMonitoringJobCallable() + *
+ *
SearchModelDeploymentMonitoringStatsAnomalies

Searches Model Monitoring Statistics generated within a given time window.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchModelDeploymentMonitoringStatsAnomalies(ModelDeploymentMonitoringJobName modelDeploymentMonitoringJob, String deployedModelId) + *
  • searchModelDeploymentMonitoringStatsAnomalies(String modelDeploymentMonitoringJob, String deployedModelId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchModelDeploymentMonitoringStatsAnomaliesPagedCallable() + *
  • searchModelDeploymentMonitoringStatsAnomaliesCallable() + *
+ *
GetModelDeploymentMonitoringJob

Gets a ModelDeploymentMonitoringJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name) + *
  • getModelDeploymentMonitoringJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelDeploymentMonitoringJobCallable() + *
+ *
ListModelDeploymentMonitoringJobs

Lists ModelDeploymentMonitoringJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelDeploymentMonitoringJobs(LocationName parent) + *
  • listModelDeploymentMonitoringJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelDeploymentMonitoringJobsPagedCallable() + *
  • listModelDeploymentMonitoringJobsCallable() + *
+ *
UpdateModelDeploymentMonitoringJob

Updates a ModelDeploymentMonitoringJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateModelDeploymentMonitoringJobOperationCallable() + *
  • updateModelDeploymentMonitoringJobCallable() + *
+ *
DeleteModelDeploymentMonitoringJob

Deletes a ModelDeploymentMonitoringJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJobName name) + *
  • deleteModelDeploymentMonitoringJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelDeploymentMonitoringJobOperationCallable() + *
  • deleteModelDeploymentMonitoringJobCallable() + *
+ *
PauseModelDeploymentMonitoringJob

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • pauseModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name) + *
  • pauseModelDeploymentMonitoringJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • pauseModelDeploymentMonitoringJobCallable() + *
+ *
ResumeModelDeploymentMonitoringJob

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • resumeModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name) + *
  • resumeModelDeploymentMonitoringJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • resumeModelDeploymentMonitoringJobCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/LlmUtilityServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/LlmUtilityServiceClient.java index 81fabf77e7e4..e29e2a99a2ce 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/LlmUtilityServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/LlmUtilityServiceClient.java @@ -67,19 +67,124 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CountTokens

Perform a token counting.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • countTokens(CountTokensRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • countTokens(EndpointName endpoint, List instances) + *
  • countTokens(String endpoint, List instances) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • countTokensCallable() + *
+ *
ComputeTokens

Return a list of tokens based on the input text.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • computeTokens(ComputeTokensRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • computeTokens(EndpointName endpoint, List instances) + *
  • computeTokens(String endpoint, List instances) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • computeTokensCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MatchServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MatchServiceClient.java index 3e8826b32c96..df06b9df3676 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MatchServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MatchServiceClient.java @@ -71,19 +71,114 @@ *

Note: close() needs to be called on the MatchServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
FindNeighbors

Finds the nearest neighbors of each vector within the request.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • findNeighbors(FindNeighborsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • findNeighborsCallable() + *
+ *
ReadIndexDatapoints

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readIndexDatapoints(ReadIndexDatapointsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readIndexDatapointsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MetadataServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MetadataServiceClient.java index 8c36a51cd1c2..da201b03f7f9 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MetadataServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MetadataServiceClient.java @@ -70,19 +70,704 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateMetadataStore

Initializes a MetadataStore, including allocation of resources.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createMetadataStoreAsync(CreateMetadataStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createMetadataStoreAsync(LocationName parent, MetadataStore metadataStore, String metadataStoreId) + *
  • createMetadataStoreAsync(String parent, MetadataStore metadataStore, String metadataStoreId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createMetadataStoreOperationCallable() + *
  • createMetadataStoreCallable() + *
+ *
GetMetadataStore

Retrieves a specific MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMetadataStore(GetMetadataStoreRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMetadataStore(MetadataStoreName name) + *
  • getMetadataStore(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMetadataStoreCallable() + *
+ *
ListMetadataStores

Lists MetadataStores for a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listMetadataStores(ListMetadataStoresRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listMetadataStores(LocationName parent) + *
  • listMetadataStores(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listMetadataStoresPagedCallable() + *
  • listMetadataStoresCallable() + *
+ *
DeleteMetadataStore

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteMetadataStoreAsync(DeleteMetadataStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteMetadataStoreAsync(MetadataStoreName name) + *
  • deleteMetadataStoreAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteMetadataStoreOperationCallable() + *
  • deleteMetadataStoreCallable() + *
+ *
CreateArtifact

Creates an Artifact associated with a MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createArtifact(CreateArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createArtifact(MetadataStoreName parent, Artifact artifact, String artifactId) + *
  • createArtifact(String parent, Artifact artifact, String artifactId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createArtifactCallable() + *
+ *
GetArtifact

Retrieves a specific Artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getArtifact(GetArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getArtifact(ArtifactName name) + *
  • getArtifact(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getArtifactCallable() + *
+ *
ListArtifacts

Lists Artifacts in the MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listArtifacts(ListArtifactsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listArtifacts(MetadataStoreName parent) + *
  • listArtifacts(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listArtifactsPagedCallable() + *
  • listArtifactsCallable() + *
+ *
UpdateArtifact

Updates a stored Artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateArtifact(UpdateArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateArtifact(Artifact artifact, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateArtifactCallable() + *
+ *
DeleteArtifact

Deletes an Artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteArtifactAsync(DeleteArtifactRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteArtifactAsync(ArtifactName name) + *
  • deleteArtifactAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteArtifactOperationCallable() + *
  • deleteArtifactCallable() + *
+ *
PurgeArtifacts

Purges Artifacts.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • purgeArtifactsAsync(PurgeArtifactsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • purgeArtifactsAsync(MetadataStoreName parent) + *
  • purgeArtifactsAsync(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • purgeArtifactsOperationCallable() + *
  • purgeArtifactsCallable() + *
+ *
CreateContext

Creates a Context associated with a MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createContext(CreateContextRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createContext(MetadataStoreName parent, Context context, String contextId) + *
  • createContext(String parent, Context context, String contextId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createContextCallable() + *
+ *
GetContext

Retrieves a specific Context.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getContext(GetContextRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getContext(ContextName name) + *
  • getContext(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getContextCallable() + *
+ *
ListContexts

Lists Contexts on the MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listContexts(ListContextsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listContexts(MetadataStoreName parent) + *
  • listContexts(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listContextsPagedCallable() + *
  • listContextsCallable() + *
+ *
UpdateContext

Updates a stored Context.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateContext(UpdateContextRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateContext(Context context, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateContextCallable() + *
+ *
DeleteContext

Deletes a stored Context.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteContextAsync(DeleteContextRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteContextAsync(ContextName name) + *
  • deleteContextAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteContextOperationCallable() + *
  • deleteContextCallable() + *
+ *
PurgeContexts

Purges Contexts.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • purgeContextsAsync(PurgeContextsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • purgeContextsAsync(MetadataStoreName parent) + *
  • purgeContextsAsync(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • purgeContextsOperationCallable() + *
  • purgeContextsCallable() + *
+ *
AddContextArtifactsAndExecutions

Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • addContextArtifactsAndExecutions(ContextName context, List artifacts, List executions) + *
  • addContextArtifactsAndExecutions(String context, List artifacts, List executions) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addContextArtifactsAndExecutionsCallable() + *
+ *
AddContextChildren

Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addContextChildren(AddContextChildrenRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • addContextChildren(ContextName context, List childContexts) + *
  • addContextChildren(String context, List childContexts) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addContextChildrenCallable() + *
+ *
RemoveContextChildren

Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • removeContextChildren(RemoveContextChildrenRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • removeContextChildren(ContextName context, List childContexts) + *
  • removeContextChildren(String context, List childContexts) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • removeContextChildrenCallable() + *
+ *
QueryContextLineageSubgraph

Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryContextLineageSubgraph(QueryContextLineageSubgraphRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryContextLineageSubgraph(ContextName context) + *
  • queryContextLineageSubgraph(String context) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryContextLineageSubgraphCallable() + *
+ *
CreateExecution

Creates an Execution associated with a MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createExecution(CreateExecutionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createExecution(MetadataStoreName parent, Execution execution, String executionId) + *
  • createExecution(String parent, Execution execution, String executionId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createExecutionCallable() + *
+ *
GetExecution

Retrieves a specific Execution.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getExecution(GetExecutionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getExecution(ExecutionName name) + *
  • getExecution(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getExecutionCallable() + *
+ *
ListExecutions

Lists Executions in the MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listExecutions(ListExecutionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listExecutions(MetadataStoreName parent) + *
  • listExecutions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listExecutionsPagedCallable() + *
  • listExecutionsCallable() + *
+ *
UpdateExecution

Updates a stored Execution.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateExecution(UpdateExecutionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateExecution(Execution execution, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateExecutionCallable() + *
+ *
DeleteExecution

Deletes an Execution.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteExecutionAsync(DeleteExecutionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteExecutionAsync(ExecutionName name) + *
  • deleteExecutionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteExecutionOperationCallable() + *
  • deleteExecutionCallable() + *
+ *
PurgeExecutions

Purges Executions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • purgeExecutionsAsync(PurgeExecutionsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • purgeExecutionsAsync(MetadataStoreName parent) + *
  • purgeExecutionsAsync(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • purgeExecutionsOperationCallable() + *
  • purgeExecutionsCallable() + *
+ *
AddExecutionEvents

Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addExecutionEvents(AddExecutionEventsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • addExecutionEvents(ExecutionName execution, List events) + *
  • addExecutionEvents(String execution, List events) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addExecutionEventsCallable() + *
+ *
QueryExecutionInputsAndOutputs

Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryExecutionInputsAndOutputs(ExecutionName execution) + *
  • queryExecutionInputsAndOutputs(String execution) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryExecutionInputsAndOutputsCallable() + *
+ *
CreateMetadataSchema

Creates a MetadataSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createMetadataSchema(CreateMetadataSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createMetadataSchema(MetadataStoreName parent, MetadataSchema metadataSchema, String metadataSchemaId) + *
  • createMetadataSchema(String parent, MetadataSchema metadataSchema, String metadataSchemaId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createMetadataSchemaCallable() + *
+ *
GetMetadataSchema

Retrieves a specific MetadataSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMetadataSchema(GetMetadataSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMetadataSchema(MetadataSchemaName name) + *
  • getMetadataSchema(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMetadataSchemaCallable() + *
+ *
ListMetadataSchemas

Lists MetadataSchemas.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listMetadataSchemas(ListMetadataSchemasRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listMetadataSchemas(MetadataStoreName parent) + *
  • listMetadataSchemas(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listMetadataSchemasPagedCallable() + *
  • listMetadataSchemasCallable() + *
+ *
QueryArtifactLineageSubgraph

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryArtifactLineageSubgraph(ArtifactName artifact) + *
  • queryArtifactLineageSubgraph(String artifact) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryArtifactLineageSubgraphCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MigrationServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MigrationServiceClient.java index a43714258c66..f24d1968b380 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MigrationServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/MigrationServiceClient.java @@ -69,19 +69,126 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
SearchMigratableResources

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchMigratableResources(SearchMigratableResourcesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchMigratableResources(LocationName parent) + *
  • searchMigratableResources(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchMigratableResourcesPagedCallable() + *
  • searchMigratableResourcesCallable() + *
+ *
BatchMigrateResources

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchMigrateResourcesAsync(BatchMigrateResourcesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchMigrateResourcesAsync(LocationName parent, List migrateResourceRequests) + *
  • batchMigrateResourcesAsync(String parent, List migrateResourceRequests) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchMigrateResourcesOperationCallable() + *
  • batchMigrateResourcesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelGardenServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelGardenServiceClient.java index eebba9d9497a..7770f5428704 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelGardenServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelGardenServiceClient.java @@ -64,19 +64,105 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
GetPublisherModel

Gets a Model Garden publisher model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPublisherModel(GetPublisherModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPublisherModel(PublisherModelName name) + *
  • getPublisherModel(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPublisherModelCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelServiceClient.java index fb94587c5a05..253c4ef3a815 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ModelServiceClient.java @@ -69,19 +69,441 @@ *

Note: close() needs to be called on the ModelServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
UploadModel

Uploads a Model artifact into Vertex AI.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • uploadModelAsync(UploadModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • uploadModelAsync(LocationName parent, Model model) + *
  • uploadModelAsync(String parent, Model model) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • uploadModelOperationCallable() + *
  • uploadModelCallable() + *
+ *
GetModel

Gets a Model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModel(GetModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModel(ModelName name) + *
  • getModel(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelCallable() + *
+ *
ListModels

Lists Models in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModels(ListModelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModels(LocationName parent) + *
  • listModels(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelsPagedCallable() + *
  • listModelsCallable() + *
+ *
ListModelVersions

Lists versions of the specified model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelVersions(ListModelVersionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelVersions(ModelName name) + *
  • listModelVersions(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelVersionsPagedCallable() + *
  • listModelVersionsCallable() + *
+ *
UpdateModel

Updates a Model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateModel(UpdateModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateModel(Model model, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateModelCallable() + *
+ *
UpdateExplanationDataset

Incrementally update the dataset used for an examples model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateExplanationDatasetAsync(UpdateExplanationDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateExplanationDatasetAsync(ModelName model) + *
  • updateExplanationDatasetAsync(String model) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateExplanationDatasetOperationCallable() + *
  • updateExplanationDatasetCallable() + *
+ *
DeleteModel

Deletes a Model. + *

A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelAsync(DeleteModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelAsync(ModelName name) + *
  • deleteModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelOperationCallable() + *
  • deleteModelCallable() + *
+ *
DeleteModelVersion

Deletes a Model version. + *

Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelVersionAsync(DeleteModelVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelVersionAsync(ModelName name) + *
  • deleteModelVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelVersionOperationCallable() + *
  • deleteModelVersionCallable() + *
+ *
MergeVersionAliases

Merges a set of aliases for a Model version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • mergeVersionAliases(MergeVersionAliasesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • mergeVersionAliases(ModelName name, List versionAliases) + *
  • mergeVersionAliases(String name, List versionAliases) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • mergeVersionAliasesCallable() + *
+ *
ExportModel

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportModelAsync(ExportModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportModelAsync(ModelName name, ExportModelRequest.OutputConfig outputConfig) + *
  • exportModelAsync(String name, ExportModelRequest.OutputConfig outputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportModelOperationCallable() + *
  • exportModelCallable() + *
+ *
CopyModel

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • copyModelAsync(CopyModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • copyModelAsync(LocationName parent, ModelName sourceModel) + *
  • copyModelAsync(LocationName parent, String sourceModel) + *
  • copyModelAsync(String parent, ModelName sourceModel) + *
  • copyModelAsync(String parent, String sourceModel) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • copyModelOperationCallable() + *
  • copyModelCallable() + *
+ *
ImportModelEvaluation

Imports an externally generated ModelEvaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importModelEvaluation(ImportModelEvaluationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • importModelEvaluation(ModelName parent, ModelEvaluation modelEvaluation) + *
  • importModelEvaluation(String parent, ModelEvaluation modelEvaluation) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importModelEvaluationCallable() + *
+ *
BatchImportModelEvaluationSlices

Imports a list of externally generated ModelEvaluationSlice.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • batchImportModelEvaluationSlices(ModelEvaluationName parent, List modelEvaluationSlices) + *
  • batchImportModelEvaluationSlices(String parent, List modelEvaluationSlices) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchImportModelEvaluationSlicesCallable() + *
+ *
BatchImportEvaluatedAnnotations

Imports a list of externally generated EvaluatedAnnotations.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • batchImportEvaluatedAnnotations(ModelEvaluationSliceName parent, List evaluatedAnnotations) + *
  • batchImportEvaluatedAnnotations(String parent, List evaluatedAnnotations) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchImportEvaluatedAnnotationsCallable() + *
+ *
GetModelEvaluation

Gets a ModelEvaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelEvaluation(GetModelEvaluationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelEvaluation(ModelEvaluationName name) + *
  • getModelEvaluation(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelEvaluationCallable() + *
+ *
ListModelEvaluations

Lists ModelEvaluations in a Model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelEvaluations(ListModelEvaluationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelEvaluations(ModelName parent) + *
  • listModelEvaluations(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelEvaluationsPagedCallable() + *
  • listModelEvaluationsCallable() + *
+ *
GetModelEvaluationSlice

Gets a ModelEvaluationSlice.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelEvaluationSlice(GetModelEvaluationSliceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelEvaluationSlice(ModelEvaluationSliceName name) + *
  • getModelEvaluationSlice(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelEvaluationSliceCallable() + *
+ *
ListModelEvaluationSlices

Lists ModelEvaluationSlices in a ModelEvaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelEvaluationSlices(ListModelEvaluationSlicesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelEvaluationSlices(ModelEvaluationName parent) + *
  • listModelEvaluationSlices(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelEvaluationSlicesPagedCallable() + *
  • listModelEvaluationSlicesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PipelineServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PipelineServiceClient.java index ce64cff258ef..38a99e43e55f 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PipelineServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PipelineServiceClient.java @@ -73,19 +73,280 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateTrainingPipeline

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTrainingPipeline(CreateTrainingPipelineRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTrainingPipeline(LocationName parent, TrainingPipeline trainingPipeline) + *
  • createTrainingPipeline(String parent, TrainingPipeline trainingPipeline) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTrainingPipelineCallable() + *
+ *
GetTrainingPipeline

Gets a TrainingPipeline.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTrainingPipeline(GetTrainingPipelineRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTrainingPipeline(TrainingPipelineName name) + *
  • getTrainingPipeline(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTrainingPipelineCallable() + *
+ *
ListTrainingPipelines

Lists TrainingPipelines in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTrainingPipelines(ListTrainingPipelinesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTrainingPipelines(LocationName parent) + *
  • listTrainingPipelines(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTrainingPipelinesPagedCallable() + *
  • listTrainingPipelinesCallable() + *
+ *
DeleteTrainingPipeline

Deletes a TrainingPipeline.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTrainingPipelineAsync(TrainingPipelineName name) + *
  • deleteTrainingPipelineAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTrainingPipelineOperationCallable() + *
  • deleteTrainingPipelineCallable() + *
+ *
CancelTrainingPipeline

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelTrainingPipeline(CancelTrainingPipelineRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelTrainingPipeline(TrainingPipelineName name) + *
  • cancelTrainingPipeline(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelTrainingPipelineCallable() + *
+ *
CreatePipelineJob

Creates a PipelineJob. A PipelineJob will run immediately when created.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createPipelineJob(CreatePipelineJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createPipelineJob(LocationName parent, PipelineJob pipelineJob, String pipelineJobId) + *
  • createPipelineJob(String parent, PipelineJob pipelineJob, String pipelineJobId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createPipelineJobCallable() + *
+ *
GetPipelineJob

Gets a PipelineJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPipelineJob(GetPipelineJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPipelineJob(PipelineJobName name) + *
  • getPipelineJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPipelineJobCallable() + *
+ *
ListPipelineJobs

Lists PipelineJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listPipelineJobs(ListPipelineJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listPipelineJobs(LocationName parent) + *
  • listPipelineJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPipelineJobsPagedCallable() + *
  • listPipelineJobsCallable() + *
+ *
DeletePipelineJob

Deletes a PipelineJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deletePipelineJobAsync(DeletePipelineJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deletePipelineJobAsync(PipelineJobName name) + *
  • deletePipelineJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deletePipelineJobOperationCallable() + *
  • deletePipelineJobCallable() + *
+ *
CancelPipelineJob

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelPipelineJob(CancelPipelineJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelPipelineJob(PipelineJobName name) + *
  • cancelPipelineJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelPipelineJobCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PredictionServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PredictionServiceClient.java index 62a2b783111f..fc690b42c55f 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PredictionServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/PredictionServiceClient.java @@ -71,19 +71,219 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
Predict

Perform an online prediction.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • predict(PredictRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • predict(EndpointName endpoint, List instances, Value parameters) + *
  • predict(String endpoint, List instances, Value parameters) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • predictCallable() + *
+ *
RawPredict

Perform an online prediction with an arbitrary HTTP payload. + *

The response includes the following HTTP headers: + *

    + *
  • `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this prediction. + *
+ *
    + *
  • `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this prediction. + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • rawPredict(RawPredictRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • rawPredict(EndpointName endpoint, HttpBody httpBody) + *
  • rawPredict(String endpoint, HttpBody httpBody) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • rawPredictCallable() + *
+ *
DirectPredict

Perform an unary online prediction request for Vertex first-party products and frameworks.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • directPredict(DirectPredictRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • directPredictCallable() + *
+ *
DirectRawPredict

Perform an online prediction request through gRPC.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • directRawPredict(DirectRawPredictRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • directRawPredictCallable() + *
+ *
StreamingPredict

Perform a streaming online prediction request for Vertex first-party products and frameworks.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamingPredictCallable() + *
+ *
ServerStreamingPredict

Perform a server-side streaming online prediction request for Vertex LLM streaming.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • serverStreamingPredictCallable() + *
+ *
StreamingRawPredict

Perform a streaming online prediction request through gRPC.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamingRawPredictCallable() + *
+ *
Explain

Perform an online explanation. + *

If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is specified, the corresponding DeployModel must have [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] populated. If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is not specified, all DeployedModels must have [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] populated.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • explain(ExplainRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • explain(EndpointName endpoint, List instances, Value parameters, String deployedModelId) + *
  • explain(String endpoint, List instances, Value parameters, String deployedModelId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • explainCallable() + *
+ *
StreamGenerateContent

Generate content with multimodal inputs with streaming support.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamGenerateContentCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ScheduleServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ScheduleServiceClient.java index 62b137965e13..266caf710b94 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ScheduleServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/ScheduleServiceClient.java @@ -72,19 +72,224 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateSchedule

Creates a Schedule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSchedule(CreateScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createSchedule(LocationName parent, Schedule schedule) + *
  • createSchedule(String parent, Schedule schedule) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createScheduleCallable() + *
+ *
DeleteSchedule

Deletes a Schedule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteScheduleAsync(DeleteScheduleRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteScheduleAsync(ScheduleName name) + *
  • deleteScheduleAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteScheduleOperationCallable() + *
  • deleteScheduleCallable() + *
+ *
GetSchedule

Gets a Schedule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSchedule(GetScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSchedule(ScheduleName name) + *
  • getSchedule(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getScheduleCallable() + *
+ *
ListSchedules

Lists Schedules in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSchedules(ListSchedulesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSchedules(LocationName parent) + *
  • listSchedules(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSchedulesPagedCallable() + *
  • listSchedulesCallable() + *
+ *
PauseSchedule

Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • pauseSchedule(PauseScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • pauseSchedule(ScheduleName name) + *
  • pauseSchedule(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • pauseScheduleCallable() + *
+ *
ResumeSchedule

Resumes a paused Schedule to start scheduling new runs. Will mark [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'ACTIVE'. Only paused Schedule can be resumed. + *

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • resumeSchedule(ResumeScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • resumeSchedule(ScheduleName name) + *
  • resumeSchedule(String name) + *
  • resumeSchedule(ScheduleName name, boolean catchUp) + *
  • resumeSchedule(String name, boolean catchUp) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • resumeScheduleCallable() + *
+ *
UpdateSchedule

Updates an active or paused Schedule. + *

When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSchedule(UpdateScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateSchedule(Schedule schedule, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateScheduleCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/SpecialistPoolServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/SpecialistPoolServiceClient.java index ef045c5b1235..9ecbdf5c3aff 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/SpecialistPoolServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/SpecialistPoolServiceClient.java @@ -76,19 +76,184 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateSpecialistPool

Creates a SpecialistPool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSpecialistPoolAsync(CreateSpecialistPoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSpecialistPoolAsync(LocationName parent, SpecialistPool specialistPool) + *
  • createSpecialistPoolAsync(String parent, SpecialistPool specialistPool) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSpecialistPoolOperationCallable() + *
  • createSpecialistPoolCallable() + *
+ *
GetSpecialistPool

Gets a SpecialistPool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSpecialistPool(GetSpecialistPoolRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSpecialistPool(SpecialistPoolName name) + *
  • getSpecialistPool(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSpecialistPoolCallable() + *
+ *
ListSpecialistPools

Lists SpecialistPools in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSpecialistPools(ListSpecialistPoolsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSpecialistPools(LocationName parent) + *
  • listSpecialistPools(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSpecialistPoolsPagedCallable() + *
  • listSpecialistPoolsCallable() + *
+ *
DeleteSpecialistPool

Deletes a SpecialistPool as well as all Specialists in the pool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteSpecialistPoolAsync(SpecialistPoolName name) + *
  • deleteSpecialistPoolAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSpecialistPoolOperationCallable() + *
  • deleteSpecialistPoolCallable() + *
+ *
UpdateSpecialistPool

Updates a SpecialistPool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSpecialistPoolAsync(UpdateSpecialistPoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateSpecialistPoolAsync(SpecialistPool specialistPool, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateSpecialistPoolOperationCallable() + *
  • updateSpecialistPoolCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/TensorboardServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/TensorboardServiceClient.java index a69a32f6e187..a57cabd764e0 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/TensorboardServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/TensorboardServiceClient.java @@ -71,19 +71,648 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateTensorboard

Creates a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardAsync(CreateTensorboardRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createTensorboardAsync(TensorboardName parent, Tensorboard tensorboard) + *
  • createTensorboardAsync(String parent, Tensorboard tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardOperationCallable() + *
  • createTensorboardCallable() + *
+ *
GetTensorboard

Gets a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboard(GetTensorboardRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboard(TensorboardName name) + *
  • getTensorboard(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardCallable() + *
+ *
UpdateTensorboard

Updates a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardAsync(UpdateTensorboardRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateTensorboardAsync(Tensorboard tensorboard, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardOperationCallable() + *
  • updateTensorboardCallable() + *
+ *
ListTensorboards

Lists Tensorboards in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboards(ListTensorboardsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboards(LocationName parent) + *
  • listTensorboards(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardsPagedCallable() + *
  • listTensorboardsCallable() + *
+ *
DeleteTensorboard

Deletes a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardAsync(DeleteTensorboardRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardAsync(TensorboardName name) + *
  • deleteTensorboardAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardOperationCallable() + *
  • deleteTensorboardCallable() + *
+ *
ReadTensorboardUsage

Returns a list of monthly active users for a given TensorBoard instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readTensorboardUsage(ReadTensorboardUsageRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readTensorboardUsage(TensorboardName tensorboard) + *
  • readTensorboardUsage(String tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardUsageCallable() + *
+ *
ReadTensorboardSize

Returns the storage size for a given TensorBoard instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readTensorboardSize(ReadTensorboardSizeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readTensorboardSize(TensorboardName tensorboard) + *
  • readTensorboardSize(String tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardSizeCallable() + *
+ *
CreateTensorboardExperiment

Creates a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardExperiment(CreateTensorboardExperimentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTensorboardExperiment(TensorboardExperimentName parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId) + *
  • createTensorboardExperiment(String parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardExperimentCallable() + *
+ *
GetTensorboardExperiment

Gets a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboardExperiment(GetTensorboardExperimentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboardExperiment(TensorboardExperimentName name) + *
  • getTensorboardExperiment(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardExperimentCallable() + *
+ *
UpdateTensorboardExperiment

Updates a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardExperiment(UpdateTensorboardExperimentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTensorboardExperiment(TensorboardExperiment tensorboardExperiment, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardExperimentCallable() + *
+ *
ListTensorboardExperiments

Lists TensorboardExperiments in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboardExperiments(ListTensorboardExperimentsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboardExperiments(TensorboardName parent) + *
  • listTensorboardExperiments(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardExperimentsPagedCallable() + *
  • listTensorboardExperimentsCallable() + *
+ *
DeleteTensorboardExperiment

Deletes a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardExperimentAsync(TensorboardExperimentName name) + *
  • deleteTensorboardExperimentAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardExperimentOperationCallable() + *
  • deleteTensorboardExperimentCallable() + *
+ *
CreateTensorboardRun

Creates a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardRun(CreateTensorboardRunRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTensorboardRun(TensorboardRunName parent, TensorboardRun tensorboardRun, String tensorboardRunId) + *
  • createTensorboardRun(String parent, TensorboardRun tensorboardRun, String tensorboardRunId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardRunCallable() + *
+ *
BatchCreateTensorboardRuns

Batch create TensorboardRuns.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateTensorboardRuns(TensorboardExperimentName parent, List requests) + *
  • batchCreateTensorboardRuns(String parent, List requests) + *
  • batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateTensorboardRunsCallable() + *
+ *
GetTensorboardRun

Gets a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboardRun(GetTensorboardRunRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboardRun(TensorboardRunName name) + *
  • getTensorboardRun(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardRunCallable() + *
+ *
UpdateTensorboardRun

Updates a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardRun(UpdateTensorboardRunRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTensorboardRun(TensorboardRun tensorboardRun, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardRunCallable() + *
+ *
ListTensorboardRuns

Lists TensorboardRuns in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboardRuns(ListTensorboardRunsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboardRuns(TensorboardExperimentName parent) + *
  • listTensorboardRuns(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardRunsPagedCallable() + *
  • listTensorboardRunsCallable() + *
+ *
DeleteTensorboardRun

Deletes a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardRunAsync(DeleteTensorboardRunRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardRunAsync(TensorboardRunName name) + *
  • deleteTensorboardRunAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardRunOperationCallable() + *
  • deleteTensorboardRunCallable() + *
+ *
BatchCreateTensorboardTimeSeries

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateTensorboardTimeSeries(TensorboardExperimentName parent, List requests) + *
  • batchCreateTensorboardTimeSeries(String parent, List requests) + *
  • batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateTensorboardTimeSeriesCallable() + *
+ *
CreateTensorboardTimeSeries

Creates a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTensorboardTimeSeries(TensorboardTimeSeriesName parent, TensorboardTimeSeries tensorboardTimeSeries) + *
  • createTensorboardTimeSeries(String parent, TensorboardTimeSeries tensorboardTimeSeries) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardTimeSeriesCallable() + *
+ *
GetTensorboardTimeSeries

Gets a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboardTimeSeries(TensorboardTimeSeriesName name) + *
  • getTensorboardTimeSeries(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardTimeSeriesCallable() + *
+ *
UpdateTensorboardTimeSeries

Updates a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTensorboardTimeSeries(TensorboardTimeSeries tensorboardTimeSeries, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardTimeSeriesCallable() + *
+ *
ListTensorboardTimeSeries

Lists TensorboardTimeSeries in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboardTimeSeries(TensorboardRunName parent) + *
  • listTensorboardTimeSeries(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardTimeSeriesPagedCallable() + *
  • listTensorboardTimeSeriesCallable() + *
+ *
DeleteTensorboardTimeSeries

Deletes a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name) + *
  • deleteTensorboardTimeSeriesAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardTimeSeriesOperationCallable() + *
  • deleteTensorboardTimeSeriesCallable() + *
+ *
BatchReadTensorboardTimeSeriesData

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • batchReadTensorboardTimeSeriesData(TensorboardName tensorboard) + *
  • batchReadTensorboardTimeSeriesData(String tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchReadTensorboardTimeSeriesDataCallable() + *
+ *
ReadTensorboardTimeSeriesData

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries) + *
  • readTensorboardTimeSeriesData(String tensorboardTimeSeries) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardTimeSeriesDataCallable() + *
+ *
ReadTensorboardBlobData

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardBlobDataCallable() + *
+ *
WriteTensorboardExperimentData

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • writeTensorboardExperimentData(TensorboardExperimentName tensorboardExperiment, List writeRunDataRequests) + *
  • writeTensorboardExperimentData(String tensorboardExperiment, List writeRunDataRequests) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • writeTensorboardExperimentDataCallable() + *
+ *
WriteTensorboardRunData

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • writeTensorboardRunData(WriteTensorboardRunDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • writeTensorboardRunData(TensorboardRunName tensorboardRun, List timeSeriesData) + *
  • writeTensorboardRunData(String tensorboardRun, List timeSeriesData) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • writeTensorboardRunDataCallable() + *
+ *
ExportTensorboardTimeSeriesData

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • exportTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries) + *
  • exportTensorboardTimeSeriesData(String tensorboardTimeSeries) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportTensorboardTimeSeriesDataPagedCallable() + *
  • exportTensorboardTimeSeriesDataCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/VizierServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/VizierServiceClient.java index d9a06c821961..4d59063017f0 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/VizierServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/VizierServiceClient.java @@ -72,19 +72,350 @@ *

Note: close() needs to be called on the VizierServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateStudy

Creates a Study. A resource name will be generated after creation of the Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createStudy(CreateStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createStudy(LocationName parent, Study study) + *
  • createStudy(String parent, Study study) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createStudyCallable() + *
+ *
GetStudy

Gets a Study by name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getStudy(GetStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getStudy(StudyName name) + *
  • getStudy(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getStudyCallable() + *
+ *
ListStudies

Lists all the studies in a region for an associated project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listStudies(ListStudiesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listStudies(LocationName parent) + *
  • listStudies(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listStudiesPagedCallable() + *
  • listStudiesCallable() + *
+ *
DeleteStudy

Deletes a Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteStudy(DeleteStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteStudy(StudyName name) + *
  • deleteStudy(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteStudyCallable() + *
+ *
LookupStudy

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • lookupStudy(LookupStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • lookupStudy(LocationName parent) + *
  • lookupStudy(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • lookupStudyCallable() + *
+ *
SuggestTrials

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.aiplatform.v1.SuggestTrialsResponse].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • suggestTrialsAsync(SuggestTrialsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • suggestTrialsOperationCallable() + *
  • suggestTrialsCallable() + *
+ *
CreateTrial

Adds a user provided Trial to a Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTrial(CreateTrialRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTrial(StudyName parent, Trial trial) + *
  • createTrial(String parent, Trial trial) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTrialCallable() + *
+ *
GetTrial

Gets a Trial.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTrial(GetTrialRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTrial(TrialName name) + *
  • getTrial(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTrialCallable() + *
+ *
ListTrials

Lists the Trials associated with a Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTrials(ListTrialsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTrials(StudyName parent) + *
  • listTrials(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTrialsPagedCallable() + *
  • listTrialsCallable() + *
+ *
AddTrialMeasurement

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addTrialMeasurement(AddTrialMeasurementRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addTrialMeasurementCallable() + *
+ *
CompleteTrial

Marks a Trial as complete.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • completeTrial(CompleteTrialRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • completeTrialCallable() + *
+ *
DeleteTrial

Deletes a Trial.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTrial(DeleteTrialRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteTrial(TrialName name) + *
  • deleteTrial(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTrialCallable() + *
+ *
CheckTrialEarlyStoppingState

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • checkTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • checkTrialEarlyStoppingStateOperationCallable() + *
  • checkTrialEarlyStoppingStateCallable() + *
+ *
StopTrial

Stops a Trial.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • stopTrial(StopTrialRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • stopTrialCallable() + *
+ *
ListOptimalTrials

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listOptimalTrials(ListOptimalTrialsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listOptimalTrials(StudyName parent) + *
  • listOptimalTrials(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listOptimalTrialsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DatasetServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DatasetServiceStubSettings.java index b1ca0daee858..cc06bfb98e94 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DatasetServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DatasetServiceStubSettings.java @@ -797,6 +797,12 @@ public DatasetServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DeploymentResourcePoolServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DeploymentResourcePoolServiceStubSettings.java index 012c7db75592..b3fc84f21e46 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DeploymentResourcePoolServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/DeploymentResourcePoolServiceStubSettings.java @@ -432,6 +432,12 @@ public DeploymentResourcePoolServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/EndpointServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/EndpointServiceStubSettings.java index 8bf1d6bd670c..4adf7343bc8b 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/EndpointServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/EndpointServiceStubSettings.java @@ -382,6 +382,12 @@ public EndpointServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreAdminServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreAdminServiceStubSettings.java index 7e6dd3536c2a..6b208fb50e7e 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreAdminServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreAdminServiceStubSettings.java @@ -609,6 +609,12 @@ public FeatureOnlineStoreAdminServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreServiceStubSettings.java index 88ba4ab13e3a..c9e7591247e0 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureOnlineStoreServiceStubSettings.java @@ -212,6 +212,12 @@ public FeatureOnlineStoreServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureRegistryServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureRegistryServiceStubSettings.java index dac50db14c0a..86cd55baea23 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureRegistryServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeatureRegistryServiceStubSettings.java @@ -463,6 +463,12 @@ public FeatureRegistryServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreOnlineServingServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreOnlineServingServiceStubSettings.java index 3139f5500174..8724c7ef1d45 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreOnlineServingServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreOnlineServingServiceStubSettings.java @@ -234,6 +234,12 @@ public FeaturestoreOnlineServingServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreServiceStubSettings.java index 6c7a20f2ea98..fc821b8d45ad 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/FeaturestoreServiceStubSettings.java @@ -758,6 +758,12 @@ public FeaturestoreServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexEndpointServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexEndpointServiceStubSettings.java index e4cf3d3b44eb..43e08e737304 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexEndpointServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexEndpointServiceStubSettings.java @@ -398,6 +398,12 @@ public IndexEndpointServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexServiceStubSettings.java index 591be449ec8c..cba0616575a5 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/IndexServiceStubSettings.java @@ -347,6 +347,12 @@ public IndexServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/JobServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/JobServiceStubSettings.java index 56639d161f5b..a89827ccfa6d 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/JobServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/JobServiceStubSettings.java @@ -1191,6 +1191,12 @@ public JobServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/LlmUtilityServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/LlmUtilityServiceStubSettings.java index 95e08d53eefe..b9cf8c8e2eaa 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/LlmUtilityServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/LlmUtilityServiceStubSettings.java @@ -218,6 +218,12 @@ public LlmUtilityServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MatchServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MatchServiceStubSettings.java index 2e852e51fd89..0ae7355b6a0a 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MatchServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MatchServiceStubSettings.java @@ -219,6 +219,12 @@ public MatchServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MetadataServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MetadataServiceStubSettings.java index 00253cc63da2..4ce417d78e8c 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MetadataServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MetadataServiceStubSettings.java @@ -854,6 +854,12 @@ public MetadataServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MigrationServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MigrationServiceStubSettings.java index 9f74ab2d86a7..f5b5a3904b3e 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MigrationServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/MigrationServiceStubSettings.java @@ -324,6 +324,12 @@ public MigrationServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelGardenServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelGardenServiceStubSettings.java index db66272f1ba8..02fb9c4841aa 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelGardenServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelGardenServiceStubSettings.java @@ -210,6 +210,12 @@ public ModelGardenServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelServiceStubSettings.java index 44fdc9371b2e..b4c950236815 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ModelServiceStubSettings.java @@ -703,6 +703,12 @@ public ModelServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PipelineServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PipelineServiceStubSettings.java index 92bc58cec094..403394ef0838 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PipelineServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PipelineServiceStubSettings.java @@ -443,6 +443,12 @@ public PipelineServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PredictionServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PredictionServiceStubSettings.java index 994548fc7351..d317df298fbb 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PredictionServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/PredictionServiceStubSettings.java @@ -284,6 +284,12 @@ public PredictionServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ScheduleServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ScheduleServiceStubSettings.java index d8c31a9bfae4..458cf32e7704 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ScheduleServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/ScheduleServiceStubSettings.java @@ -324,6 +324,12 @@ public ScheduleServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/SpecialistPoolServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/SpecialistPoolServiceStubSettings.java index ea0328b04b97..f18d5c65f154 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/SpecialistPoolServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/SpecialistPoolServiceStubSettings.java @@ -347,6 +347,12 @@ public SpecialistPoolServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/TensorboardServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/TensorboardServiceStubSettings.java index 2c74718fc81b..d754f3ef46ad 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/TensorboardServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/TensorboardServiceStubSettings.java @@ -942,6 +942,12 @@ public TensorboardServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/VizierServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/VizierServiceStubSettings.java index 834b6189a340..16f2d7b9298c 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/VizierServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/VizierServiceStubSettings.java @@ -460,6 +460,12 @@ public VizierServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DatasetServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DatasetServiceClient.java index 8cda62de454d..8a2503d01f0a 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DatasetServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DatasetServiceClient.java @@ -70,19 +70,436 @@ *

Note: close() needs to be called on the DatasetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateDataset

Creates a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDatasetAsync(CreateDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createDatasetAsync(LocationName parent, Dataset dataset) + *
  • createDatasetAsync(String parent, Dataset dataset) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDatasetOperationCallable() + *
  • createDatasetCallable() + *
+ *
GetDataset

Gets a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataset(GetDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataset(DatasetName name) + *
  • getDataset(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDatasetCallable() + *
+ *
UpdateDataset

Updates a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataset(UpdateDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataset(Dataset dataset, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDatasetCallable() + *
+ *
ListDatasets

Lists Datasets in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDatasets(ListDatasetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDatasets(LocationName parent) + *
  • listDatasets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDatasetsPagedCallable() + *
  • listDatasetsCallable() + *
+ *
DeleteDataset

Deletes a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDatasetAsync(DeleteDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDatasetAsync(DatasetName name) + *
  • deleteDatasetAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDatasetOperationCallable() + *
  • deleteDatasetCallable() + *
+ *
ImportData

Imports data into a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importDataAsync(ImportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • importDataAsync(DatasetName name, List importConfigs) + *
  • importDataAsync(String name, List importConfigs) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importDataOperationCallable() + *
  • importDataCallable() + *
+ *
ExportData

Exports data from a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportDataAsync(ExportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportDataAsync(DatasetName name, ExportDataConfig exportConfig) + *
  • exportDataAsync(String name, ExportDataConfig exportConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportDataOperationCallable() + *
  • exportDataCallable() + *
+ *
CreateDatasetVersion

Create a version from a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDatasetVersionAsync(CreateDatasetVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createDatasetVersionAsync(DatasetName parent, DatasetVersion datasetVersion) + *
  • createDatasetVersionAsync(String parent, DatasetVersion datasetVersion) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDatasetVersionOperationCallable() + *
  • createDatasetVersionCallable() + *
+ *
DeleteDatasetVersion

Deletes a Dataset version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDatasetVersionAsync(DeleteDatasetVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDatasetVersionAsync(DatasetVersionName name) + *
  • deleteDatasetVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDatasetVersionOperationCallable() + *
  • deleteDatasetVersionCallable() + *
+ *
GetDatasetVersion

Gets a Dataset version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDatasetVersion(GetDatasetVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDatasetVersion(DatasetVersionName name) + *
  • getDatasetVersion(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDatasetVersionCallable() + *
+ *
ListDatasetVersions

Lists DatasetVersions in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDatasetVersions(ListDatasetVersionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDatasetVersions(DatasetName parent) + *
  • listDatasetVersions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDatasetVersionsPagedCallable() + *
  • listDatasetVersionsCallable() + *
+ *
RestoreDatasetVersion

Restores a dataset version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restoreDatasetVersionAsync(RestoreDatasetVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • restoreDatasetVersionAsync(DatasetVersionName name) + *
  • restoreDatasetVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restoreDatasetVersionOperationCallable() + *
  • restoreDatasetVersionCallable() + *
+ *
ListDataItems

Lists DataItems in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDataItems(ListDataItemsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDataItems(DatasetName parent) + *
  • listDataItems(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDataItemsPagedCallable() + *
  • listDataItemsCallable() + *
+ *
SearchDataItems

Searches DataItems in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchDataItems(SearchDataItemsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchDataItemsPagedCallable() + *
  • searchDataItemsCallable() + *
+ *
ListSavedQueries

Lists SavedQueries in a Dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSavedQueries(ListSavedQueriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSavedQueries(DatasetName parent) + *
  • listSavedQueries(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSavedQueriesPagedCallable() + *
  • listSavedQueriesCallable() + *
+ *
DeleteSavedQuery

Deletes a SavedQuery.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSavedQueryAsync(DeleteSavedQueryRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteSavedQueryAsync(SavedQueryName name) + *
  • deleteSavedQueryAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSavedQueryOperationCallable() + *
  • deleteSavedQueryCallable() + *
+ *
GetAnnotationSpec

Gets an AnnotationSpec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAnnotationSpec(GetAnnotationSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAnnotationSpec(AnnotationSpecName name) + *
  • getAnnotationSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAnnotationSpecCallable() + *
+ *
ListAnnotations

Lists Annotations belongs to a dataitem

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAnnotations(ListAnnotationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAnnotations(DataItemName parent) + *
  • listAnnotations(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAnnotationsPagedCallable() + *
  • listAnnotationsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DeploymentResourcePoolServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DeploymentResourcePoolServiceClient.java index 83ef1efb64b6..f4cb6e3d5c75 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DeploymentResourcePoolServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/DeploymentResourcePoolServiceClient.java @@ -73,19 +73,184 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateDeploymentResourcePool

Create a DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDeploymentResourcePoolAsync(CreateDeploymentResourcePoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createDeploymentResourcePoolAsync(LocationName parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId) + *
  • createDeploymentResourcePoolAsync(String parent, DeploymentResourcePool deploymentResourcePool, String deploymentResourcePoolId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDeploymentResourcePoolOperationCallable() + *
  • createDeploymentResourcePoolCallable() + *
+ *
GetDeploymentResourcePool

Get a DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDeploymentResourcePool(GetDeploymentResourcePoolRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDeploymentResourcePool(DeploymentResourcePoolName name) + *
  • getDeploymentResourcePool(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDeploymentResourcePoolCallable() + *
+ *
ListDeploymentResourcePools

List DeploymentResourcePools in a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDeploymentResourcePools(ListDeploymentResourcePoolsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDeploymentResourcePools(ProjectName parent) + *
  • listDeploymentResourcePools(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDeploymentResourcePoolsPagedCallable() + *
  • listDeploymentResourcePoolsCallable() + *
+ *
DeleteDeploymentResourcePool

Delete a DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDeploymentResourcePoolAsync(DeleteDeploymentResourcePoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDeploymentResourcePoolAsync(DeploymentResourcePoolName name) + *
  • deleteDeploymentResourcePoolAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDeploymentResourcePoolOperationCallable() + *
  • deleteDeploymentResourcePoolCallable() + *
+ *
QueryDeployedModels

List DeployedModels that have been deployed on this DeploymentResourcePool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryDeployedModels(QueryDeployedModelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryDeployedModels(String deploymentResourcePool) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryDeployedModelsPagedCallable() + *
  • queryDeployedModelsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/EndpointServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/EndpointServiceClient.java index 9e0dd070b331..e1c213df8308 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/EndpointServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/EndpointServiceClient.java @@ -73,19 +73,245 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateEndpoint

Creates an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createEndpointAsync(CreateEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createEndpointAsync(LocationName parent, Endpoint endpoint) + *
  • createEndpointAsync(String parent, Endpoint endpoint) + *
  • createEndpointAsync(LocationName parent, Endpoint endpoint, String endpointId) + *
  • createEndpointAsync(String parent, Endpoint endpoint, String endpointId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createEndpointOperationCallable() + *
  • createEndpointCallable() + *
+ *
GetEndpoint

Gets an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getEndpoint(GetEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getEndpoint(EndpointName name) + *
  • getEndpoint(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getEndpointCallable() + *
+ *
ListEndpoints

Lists Endpoints in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listEndpoints(ListEndpointsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listEndpoints(LocationName parent) + *
  • listEndpoints(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listEndpointsPagedCallable() + *
  • listEndpointsCallable() + *
+ *
UpdateEndpoint

Updates an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateEndpoint(UpdateEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateEndpoint(Endpoint endpoint, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateEndpointCallable() + *
+ *
DeleteEndpoint

Deletes an Endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteEndpointAsync(DeleteEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteEndpointAsync(EndpointName name) + *
  • deleteEndpointAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteEndpointOperationCallable() + *
  • deleteEndpointCallable() + *
+ *
DeployModel

Deploys a Model into this Endpoint, creating a DeployedModel within it.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deployModelAsync(DeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deployModelAsync(EndpointName endpoint, DeployedModel deployedModel, Map trafficSplit) + *
  • deployModelAsync(String endpoint, DeployedModel deployedModel, Map trafficSplit) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deployModelOperationCallable() + *
  • deployModelCallable() + *
+ *
UndeployModel

Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • undeployModelAsync(UndeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • undeployModelAsync(EndpointName endpoint, String deployedModelId, Map trafficSplit) + *
  • undeployModelAsync(String endpoint, String deployedModelId, Map trafficSplit) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • undeployModelOperationCallable() + *
  • undeployModelCallable() + *
+ *
MutateDeployedModel

Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • mutateDeployedModelAsync(MutateDeployedModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • mutateDeployedModelAsync(EndpointName endpoint, DeployedModel deployedModel, FieldMask updateMask) + *
  • mutateDeployedModelAsync(String endpoint, DeployedModel deployedModel, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • mutateDeployedModelOperationCallable() + *
  • mutateDeployedModelCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreAdminServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreAdminServiceClient.java index e0f94833da7a..d69184301f58 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreAdminServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreAdminServiceClient.java @@ -74,19 +74,340 @@ * up resources such as threads. In the example above, try-with-resources is used, which * automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateFeatureOnlineStore

Creates a new FeatureOnlineStore in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureOnlineStoreAsync(CreateFeatureOnlineStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureOnlineStoreAsync(LocationName parent, FeatureOnlineStore featureOnlineStore, String featureOnlineStoreId) + *
  • createFeatureOnlineStoreAsync(String parent, FeatureOnlineStore featureOnlineStore, String featureOnlineStoreId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureOnlineStoreOperationCallable() + *
  • createFeatureOnlineStoreCallable() + *
+ *
GetFeatureOnlineStore

Gets details of a single FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureOnlineStore(GetFeatureOnlineStoreRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureOnlineStore(FeatureOnlineStoreName name) + *
  • getFeatureOnlineStore(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureOnlineStoreCallable() + *
+ *
ListFeatureOnlineStores

Lists FeatureOnlineStores in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureOnlineStores(ListFeatureOnlineStoresRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureOnlineStores(LocationName parent) + *
  • listFeatureOnlineStores(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureOnlineStoresPagedCallable() + *
  • listFeatureOnlineStoresCallable() + *
+ *
UpdateFeatureOnlineStore

Updates the parameters of a single FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureOnlineStoreAsync(UpdateFeatureOnlineStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureOnlineStoreAsync(FeatureOnlineStore featureOnlineStore, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureOnlineStoreOperationCallable() + *
  • updateFeatureOnlineStoreCallable() + *
+ *
DeleteFeatureOnlineStore

Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureOnlineStoreAsync(DeleteFeatureOnlineStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureOnlineStoreAsync(FeatureOnlineStoreName name, boolean force) + *
  • deleteFeatureOnlineStoreAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureOnlineStoreOperationCallable() + *
  • deleteFeatureOnlineStoreCallable() + *
+ *
CreateFeatureView

Creates a new FeatureView in a given FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureViewAsync(CreateFeatureViewRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureViewAsync(FeatureOnlineStoreName parent, FeatureView featureView, String featureViewId) + *
  • createFeatureViewAsync(String parent, FeatureView featureView, String featureViewId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureViewOperationCallable() + *
  • createFeatureViewCallable() + *
+ *
GetFeatureView

Gets details of a single FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureView(GetFeatureViewRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureView(FeatureViewName name) + *
  • getFeatureView(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureViewCallable() + *
+ *
ListFeatureViews

Lists FeatureViews in a given FeatureOnlineStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureViews(ListFeatureViewsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureViews(FeatureOnlineStoreName parent) + *
  • listFeatureViews(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureViewsPagedCallable() + *
  • listFeatureViewsCallable() + *
+ *
UpdateFeatureView

Updates the parameters of a single FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureViewAsync(UpdateFeatureViewRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureViewAsync(FeatureView featureView, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureViewOperationCallable() + *
  • updateFeatureViewCallable() + *
+ *
DeleteFeatureView

Deletes a single FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureViewAsync(DeleteFeatureViewRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureViewAsync(FeatureViewName name) + *
  • deleteFeatureViewAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureViewOperationCallable() + *
  • deleteFeatureViewCallable() + *
+ *
SyncFeatureView

Triggers on-demand sync for the FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • syncFeatureView(SyncFeatureViewRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • syncFeatureView(FeatureViewName featureView) + *
  • syncFeatureView(String featureView) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • syncFeatureViewCallable() + *
+ *
GetFeatureViewSync

Gets details of a single FeatureViewSync.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureViewSync(GetFeatureViewSyncRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureViewSync(FeatureViewSyncName name) + *
  • getFeatureViewSync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureViewSyncCallable() + *
+ *
ListFeatureViewSyncs

Lists FeatureViewSyncs in a given FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureViewSyncs(ListFeatureViewSyncsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureViewSyncs(FeatureViewName parent) + *
  • listFeatureViewSyncs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureViewSyncsPagedCallable() + *
  • listFeatureViewSyncsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreServiceClient.java index 74819fe3813d..77eeb9637122 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureOnlineStoreServiceClient.java @@ -67,19 +67,119 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
FetchFeatureValues

Fetch feature values under a FeatureView.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • fetchFeatureValues(FetchFeatureValuesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • fetchFeatureValues(FeatureViewName featureView, FeatureViewDataKey dataKey) + *
  • fetchFeatureValues(String featureView, FeatureViewDataKey dataKey) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • fetchFeatureValuesCallable() + *
+ *
SearchNearestEntities

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchNearestEntities(SearchNearestEntitiesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchNearestEntitiesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureRegistryServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureRegistryServiceClient.java index 651601a79343..09da2984b4ea 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureRegistryServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeatureRegistryServiceClient.java @@ -72,19 +72,284 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateFeatureGroup

Creates a new FeatureGroup in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureGroupAsync(CreateFeatureGroupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureGroupAsync(LocationName parent, FeatureGroup featureGroup, String featureGroupId) + *
  • createFeatureGroupAsync(String parent, FeatureGroup featureGroup, String featureGroupId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureGroupOperationCallable() + *
  • createFeatureGroupCallable() + *
+ *
GetFeatureGroup

Gets details of a single FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeatureGroup(GetFeatureGroupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeatureGroup(FeatureGroupName name) + *
  • getFeatureGroup(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureGroupCallable() + *
+ *
ListFeatureGroups

Lists FeatureGroups in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatureGroups(ListFeatureGroupsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatureGroups(LocationName parent) + *
  • listFeatureGroups(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeatureGroupsPagedCallable() + *
  • listFeatureGroupsCallable() + *
+ *
UpdateFeatureGroup

Updates the parameters of a single FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureGroupAsync(UpdateFeatureGroupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureGroupAsync(FeatureGroup featureGroup, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureGroupOperationCallable() + *
  • updateFeatureGroupCallable() + *
+ *
DeleteFeatureGroup

Deletes a single FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureGroupAsync(DeleteFeatureGroupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureGroupAsync(FeatureGroupName name, boolean force) + *
  • deleteFeatureGroupAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureGroupOperationCallable() + *
  • deleteFeatureGroupCallable() + *
+ *
CreateFeature

Creates a new Feature in a given FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureAsync(CreateFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureAsync(EntityTypeName parent, Feature feature, String featureId) + *
  • createFeatureAsync(FeatureGroupName parent, Feature feature, String featureId) + *
  • createFeatureAsync(String parent, Feature feature, String featureId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureOperationCallable() + *
  • createFeatureCallable() + *
+ *
GetFeature

Gets details of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeature(GetFeatureRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeature(FeatureName name) + *
  • getFeature(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureCallable() + *
+ *
ListFeatures

Lists Features in a given FeatureGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatures(ListFeaturesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatures(EntityTypeName parent) + *
  • listFeatures(FeatureGroupName parent) + *
  • listFeatures(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeaturesPagedCallable() + *
  • listFeaturesCallable() + *
+ *
UpdateFeature

Updates the parameters of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeatureAsync(UpdateFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeatureAsync(Feature feature, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureOperationCallable() + *
  • updateFeatureCallable() + *
+ *
DeleteFeature

Deletes a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureAsync(DeleteFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureAsync(FeatureName name) + *
  • deleteFeatureAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureOperationCallable() + *
  • deleteFeatureCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreOnlineServingServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreOnlineServingServiceClient.java index c6305f41f0c9..f0fd220ff8fa 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreOnlineServingServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreOnlineServingServiceClient.java @@ -69,19 +69,135 @@ * up resources such as threads. In the example above, try-with-resources is used, which * automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ReadFeatureValues

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readFeatureValues(ReadFeatureValuesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readFeatureValues(EntityTypeName entityType) + *
  • readFeatureValues(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readFeatureValuesCallable() + *
+ *
StreamingReadFeatureValues

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamingReadFeatureValuesCallable() + *
+ *
WriteFeatureValues

Writes Feature values of one or more entities of an EntityType. + *

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • writeFeatureValues(WriteFeatureValuesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • writeFeatureValues(EntityTypeName entityType, List payloads) + *
  • writeFeatureValues(String entityType, List payloads) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • writeFeatureValuesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreServiceClient.java index 720264c2cd05..467f05b7d91b 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreServiceClient.java @@ -71,19 +71,517 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateFeaturestore

Creates a new Featurestore in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeaturestoreAsync(CreateFeaturestoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeaturestoreAsync(LocationName parent, Featurestore featurestore) + *
  • createFeaturestoreAsync(String parent, Featurestore featurestore) + *
  • createFeaturestoreAsync(LocationName parent, Featurestore featurestore, String featurestoreId) + *
  • createFeaturestoreAsync(String parent, Featurestore featurestore, String featurestoreId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeaturestoreOperationCallable() + *
  • createFeaturestoreCallable() + *
+ *
GetFeaturestore

Gets details of a single Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeaturestore(GetFeaturestoreRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeaturestore(FeaturestoreName name) + *
  • getFeaturestore(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeaturestoreCallable() + *
+ *
ListFeaturestores

Lists Featurestores in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeaturestores(ListFeaturestoresRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeaturestores(LocationName parent) + *
  • listFeaturestores(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeaturestoresPagedCallable() + *
  • listFeaturestoresCallable() + *
+ *
UpdateFeaturestore

Updates the parameters of a single Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeaturestoreAsync(UpdateFeaturestoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateFeaturestoreAsync(Featurestore featurestore, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeaturestoreOperationCallable() + *
  • updateFeaturestoreCallable() + *
+ *
DeleteFeaturestore

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeaturestoreAsync(DeleteFeaturestoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeaturestoreAsync(FeaturestoreName name) + *
  • deleteFeaturestoreAsync(String name) + *
  • deleteFeaturestoreAsync(FeaturestoreName name, boolean force) + *
  • deleteFeaturestoreAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeaturestoreOperationCallable() + *
  • deleteFeaturestoreCallable() + *
+ *
CreateEntityType

Creates a new EntityType in a given Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createEntityTypeAsync(CreateEntityTypeRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createEntityTypeAsync(FeaturestoreName parent, EntityType entityType) + *
  • createEntityTypeAsync(String parent, EntityType entityType) + *
  • createEntityTypeAsync(FeaturestoreName parent, EntityType entityType, String entityTypeId) + *
  • createEntityTypeAsync(String parent, EntityType entityType, String entityTypeId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createEntityTypeOperationCallable() + *
  • createEntityTypeCallable() + *
+ *
GetEntityType

Gets details of a single EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getEntityType(GetEntityTypeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getEntityType(EntityTypeName name) + *
  • getEntityType(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getEntityTypeCallable() + *
+ *
ListEntityTypes

Lists EntityTypes in a given Featurestore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listEntityTypes(ListEntityTypesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listEntityTypes(FeaturestoreName parent) + *
  • listEntityTypes(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listEntityTypesPagedCallable() + *
  • listEntityTypesCallable() + *
+ *
UpdateEntityType

Updates the parameters of a single EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateEntityType(UpdateEntityTypeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateEntityType(EntityType entityType, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateEntityTypeCallable() + *
+ *
DeleteEntityType

Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteEntityTypeAsync(DeleteEntityTypeRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteEntityTypeAsync(EntityTypeName name) + *
  • deleteEntityTypeAsync(String name) + *
  • deleteEntityTypeAsync(EntityTypeName name, boolean force) + *
  • deleteEntityTypeAsync(String name, boolean force) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteEntityTypeOperationCallable() + *
  • deleteEntityTypeCallable() + *
+ *
CreateFeature

Creates a new Feature in a given EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeatureAsync(CreateFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createFeatureAsync(EntityTypeName parent, Feature feature) + *
  • createFeatureAsync(FeatureGroupName parent, Feature feature) + *
  • createFeatureAsync(String parent, Feature feature) + *
  • createFeatureAsync(EntityTypeName parent, Feature feature, String featureId) + *
  • createFeatureAsync(FeatureGroupName parent, Feature feature, String featureId) + *
  • createFeatureAsync(String parent, Feature feature, String featureId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeatureOperationCallable() + *
  • createFeatureCallable() + *
+ *
BatchCreateFeatures

Creates a batch of Features in a given EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateFeaturesAsync(EntityTypeName parent, List requests) + *
  • batchCreateFeaturesAsync(String parent, List requests) + *
  • batchCreateFeaturesAsync(BatchCreateFeaturesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateFeaturesOperationCallable() + *
  • batchCreateFeaturesCallable() + *
+ *
GetFeature

Gets details of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeature(GetFeatureRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeature(FeatureName name) + *
  • getFeature(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeatureCallable() + *
+ *
ListFeatures

Lists Features in a given EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeatures(ListFeaturesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeatures(EntityTypeName parent) + *
  • listFeatures(FeatureGroupName parent) + *
  • listFeatures(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeaturesPagedCallable() + *
  • listFeaturesCallable() + *
+ *
UpdateFeature

Updates the parameters of a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeature(UpdateFeatureRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateFeature(Feature feature, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeatureCallable() + *
+ *
DeleteFeature

Deletes a single Feature.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureAsync(DeleteFeatureRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureAsync(FeatureName name) + *
  • deleteFeatureAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureOperationCallable() + *
  • deleteFeatureCallable() + *
+ *
ImportFeatureValues

Imports Feature values into the Featurestore from a source storage. + *

The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. + *

If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. + *

There are also scenarios where the caller can cause inconsistency. + *

- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importFeatureValuesAsync(ImportFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • importFeatureValuesAsync(EntityTypeName entityType) + *
  • importFeatureValuesAsync(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importFeatureValuesOperationCallable() + *
  • importFeatureValuesCallable() + *
+ *
BatchReadFeatureValues

Batch reads Feature values from a Featurestore. + *

This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchReadFeatureValuesAsync(BatchReadFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchReadFeatureValuesAsync(FeaturestoreName featurestore) + *
  • batchReadFeatureValuesAsync(String featurestore) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchReadFeatureValuesOperationCallable() + *
  • batchReadFeatureValuesCallable() + *
+ *
ExportFeatureValues

Exports Feature values from all the entities of a target EntityType.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportFeatureValuesAsync(ExportFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportFeatureValuesAsync(EntityTypeName entityType) + *
  • exportFeatureValuesAsync(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportFeatureValuesOperationCallable() + *
  • exportFeatureValuesCallable() + *
+ *
DeleteFeatureValues

Delete Feature values from Featurestore. + *

The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. + *

If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeatureValuesAsync(DeleteFeatureValuesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteFeatureValuesAsync(EntityTypeName entityType) + *
  • deleteFeatureValuesAsync(String entityType) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeatureValuesOperationCallable() + *
  • deleteFeatureValuesCallable() + *
+ *
SearchFeatures

Searches Features matching a query in a given project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchFeatures(SearchFeaturesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchFeatures(LocationName location) + *
  • searchFeatures(String location) + *
  • searchFeatures(LocationName location, String query) + *
  • searchFeatures(String location, String query) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchFeaturesPagedCallable() + *
  • searchFeaturesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexEndpointServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexEndpointServiceClient.java index 3e41cc081b48..44d238c66dc3 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexEndpointServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexEndpointServiceClient.java @@ -72,19 +72,243 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateIndexEndpoint

Creates an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createIndexEndpointAsync(CreateIndexEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createIndexEndpointAsync(LocationName parent, IndexEndpoint indexEndpoint) + *
  • createIndexEndpointAsync(String parent, IndexEndpoint indexEndpoint) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createIndexEndpointOperationCallable() + *
  • createIndexEndpointCallable() + *
+ *
GetIndexEndpoint

Gets an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIndexEndpoint(GetIndexEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getIndexEndpoint(IndexEndpointName name) + *
  • getIndexEndpoint(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIndexEndpointCallable() + *
+ *
ListIndexEndpoints

Lists IndexEndpoints in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listIndexEndpoints(ListIndexEndpointsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listIndexEndpoints(LocationName parent) + *
  • listIndexEndpoints(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listIndexEndpointsPagedCallable() + *
  • listIndexEndpointsCallable() + *
+ *
UpdateIndexEndpoint

Updates an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateIndexEndpoint(UpdateIndexEndpointRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateIndexEndpoint(IndexEndpoint indexEndpoint, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateIndexEndpointCallable() + *
+ *
DeleteIndexEndpoint

Deletes an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteIndexEndpointAsync(DeleteIndexEndpointRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteIndexEndpointAsync(IndexEndpointName name) + *
  • deleteIndexEndpointAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteIndexEndpointOperationCallable() + *
  • deleteIndexEndpointCallable() + *
+ *
DeployIndex

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deployIndexAsync(DeployIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deployIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex) + *
  • deployIndexAsync(String indexEndpoint, DeployedIndex deployedIndex) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deployIndexOperationCallable() + *
  • deployIndexCallable() + *
+ *
UndeployIndex

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • undeployIndexAsync(UndeployIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • undeployIndexAsync(IndexEndpointName indexEndpoint, String deployedIndexId) + *
  • undeployIndexAsync(String indexEndpoint, String deployedIndexId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • undeployIndexOperationCallable() + *
  • undeployIndexCallable() + *
+ *
MutateDeployedIndex

Update an existing DeployedIndex under an IndexEndpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • mutateDeployedIndexAsync(MutateDeployedIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • mutateDeployedIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex) + *
  • mutateDeployedIndexAsync(String indexEndpoint, DeployedIndex deployedIndex) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • mutateDeployedIndexOperationCallable() + *
  • mutateDeployedIndexCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexServiceClient.java index 4ef920820193..56404b30ed3d 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexServiceClient.java @@ -70,19 +70,212 @@ *

Note: close() needs to be called on the IndexServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateIndex

Creates an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createIndexAsync(CreateIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createIndexAsync(LocationName parent, Index index) + *
  • createIndexAsync(String parent, Index index) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createIndexOperationCallable() + *
  • createIndexCallable() + *
+ *
GetIndex

Gets an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIndex(GetIndexRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getIndex(IndexName name) + *
  • getIndex(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIndexCallable() + *
+ *
ListIndexes

Lists Indexes in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listIndexes(ListIndexesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listIndexes(LocationName parent) + *
  • listIndexes(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listIndexesPagedCallable() + *
  • listIndexesCallable() + *
+ *
UpdateIndex

Updates an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateIndexAsync(UpdateIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateIndexAsync(Index index, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateIndexOperationCallable() + *
  • updateIndexCallable() + *
+ *
DeleteIndex

Deletes an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1beta1.Index.deployed_indexes] had been undeployed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteIndexAsync(DeleteIndexRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteIndexAsync(IndexName name) + *
  • deleteIndexAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteIndexOperationCallable() + *
  • deleteIndexCallable() + *
+ *
UpsertDatapoints

Add/update Datapoints into an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • upsertDatapoints(UpsertDatapointsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • upsertDatapointsCallable() + *
+ *
RemoveDatapoints

Remove Datapoints from an Index.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • removeDatapoints(RemoveDatapointsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • removeDatapointsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/JobServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/JobServiceClient.java index de6910e85dfb..d4cc4ccc6e97 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/JobServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/JobServiceClient.java @@ -71,19 +71,766 @@ *

Note: close() needs to be called on the JobServiceClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateCustomJob

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createCustomJob(CreateCustomJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createCustomJob(LocationName parent, CustomJob customJob) + *
  • createCustomJob(String parent, CustomJob customJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createCustomJobCallable() + *
+ *
GetCustomJob

Gets a CustomJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCustomJob(GetCustomJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCustomJob(CustomJobName name) + *
  • getCustomJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getCustomJobCallable() + *
+ *
ListCustomJobs

Lists CustomJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listCustomJobs(ListCustomJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listCustomJobs(LocationName parent) + *
  • listCustomJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listCustomJobsPagedCallable() + *
  • listCustomJobsCallable() + *
+ *
DeleteCustomJob

Deletes a CustomJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteCustomJobAsync(DeleteCustomJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteCustomJobAsync(CustomJobName name) + *
  • deleteCustomJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteCustomJobOperationCallable() + *
  • deleteCustomJobCallable() + *
+ *
CancelCustomJob

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1beta1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1beta1.CustomJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelCustomJob(CancelCustomJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelCustomJob(CustomJobName name) + *
  • cancelCustomJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelCustomJobCallable() + *
+ *
CreateDataLabelingJob

Creates a DataLabelingJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDataLabelingJob(CreateDataLabelingJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDataLabelingJob(LocationName parent, DataLabelingJob dataLabelingJob) + *
  • createDataLabelingJob(String parent, DataLabelingJob dataLabelingJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDataLabelingJobCallable() + *
+ *
GetDataLabelingJob

Gets a DataLabelingJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataLabelingJob(GetDataLabelingJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataLabelingJob(DataLabelingJobName name) + *
  • getDataLabelingJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataLabelingJobCallable() + *
+ *
ListDataLabelingJobs

Lists DataLabelingJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDataLabelingJobs(ListDataLabelingJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDataLabelingJobs(LocationName parent) + *
  • listDataLabelingJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDataLabelingJobsPagedCallable() + *
  • listDataLabelingJobsCallable() + *
+ *
DeleteDataLabelingJob

Deletes a DataLabelingJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDataLabelingJobAsync(DataLabelingJobName name) + *
  • deleteDataLabelingJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDataLabelingJobOperationCallable() + *
  • deleteDataLabelingJobCallable() + *
+ *
CancelDataLabelingJob

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelDataLabelingJob(CancelDataLabelingJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelDataLabelingJob(DataLabelingJobName name) + *
  • cancelDataLabelingJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelDataLabelingJobCallable() + *
+ *
CreateHyperparameterTuningJob

Creates a HyperparameterTuningJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createHyperparameterTuningJob(LocationName parent, HyperparameterTuningJob hyperparameterTuningJob) + *
  • createHyperparameterTuningJob(String parent, HyperparameterTuningJob hyperparameterTuningJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createHyperparameterTuningJobCallable() + *
+ *
GetHyperparameterTuningJob

Gets a HyperparameterTuningJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getHyperparameterTuningJob(HyperparameterTuningJobName name) + *
  • getHyperparameterTuningJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getHyperparameterTuningJobCallable() + *
+ *
ListHyperparameterTuningJobs

Lists HyperparameterTuningJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listHyperparameterTuningJobs(LocationName parent) + *
  • listHyperparameterTuningJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listHyperparameterTuningJobsPagedCallable() + *
  • listHyperparameterTuningJobsCallable() + *
+ *
DeleteHyperparameterTuningJob

Deletes a HyperparameterTuningJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteHyperparameterTuningJobAsync(HyperparameterTuningJobName name) + *
  • deleteHyperparameterTuningJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteHyperparameterTuningJobOperationCallable() + *
  • deleteHyperparameterTuningJobCallable() + *
+ *
CancelHyperparameterTuningJob

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelHyperparameterTuningJob(HyperparameterTuningJobName name) + *
  • cancelHyperparameterTuningJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelHyperparameterTuningJobCallable() + *
+ *
CreateNasJob

Creates a NasJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createNasJob(CreateNasJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createNasJob(LocationName parent, NasJob nasJob) + *
  • createNasJob(String parent, NasJob nasJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createNasJobCallable() + *
+ *
GetNasJob

Gets a NasJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getNasJob(GetNasJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getNasJob(NasJobName name) + *
  • getNasJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getNasJobCallable() + *
+ *
ListNasJobs

Lists NasJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listNasJobs(ListNasJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listNasJobs(LocationName parent) + *
  • listNasJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listNasJobsPagedCallable() + *
  • listNasJobsCallable() + *
+ *
DeleteNasJob

Deletes a NasJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteNasJobAsync(DeleteNasJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteNasJobAsync(NasJobName name) + *
  • deleteNasJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteNasJobOperationCallable() + *
  • deleteNasJobCallable() + *
+ *
CancelNasJob

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1beta1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1beta1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1beta1.NasJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelNasJob(CancelNasJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelNasJob(NasJobName name) + *
  • cancelNasJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelNasJobCallable() + *
+ *
GetNasTrialDetail

Gets a NasTrialDetail.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getNasTrialDetail(GetNasTrialDetailRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getNasTrialDetail(NasTrialDetailName name) + *
  • getNasTrialDetail(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getNasTrialDetailCallable() + *
+ *
ListNasTrialDetails

List top NasTrialDetails of a NasJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listNasTrialDetails(ListNasTrialDetailsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listNasTrialDetails(NasJobName parent) + *
  • listNasTrialDetails(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listNasTrialDetailsPagedCallable() + *
  • listNasTrialDetailsCallable() + *
+ *
CreateBatchPredictionJob

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createBatchPredictionJob(CreateBatchPredictionJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createBatchPredictionJob(LocationName parent, BatchPredictionJob batchPredictionJob) + *
  • createBatchPredictionJob(String parent, BatchPredictionJob batchPredictionJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createBatchPredictionJobCallable() + *
+ *
GetBatchPredictionJob

Gets a BatchPredictionJob

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getBatchPredictionJob(GetBatchPredictionJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getBatchPredictionJob(BatchPredictionJobName name) + *
  • getBatchPredictionJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getBatchPredictionJobCallable() + *
+ *
ListBatchPredictionJobs

Lists BatchPredictionJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listBatchPredictionJobs(ListBatchPredictionJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listBatchPredictionJobs(LocationName parent) + *
  • listBatchPredictionJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listBatchPredictionJobsPagedCallable() + *
  • listBatchPredictionJobsCallable() + *
+ *
DeleteBatchPredictionJob

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteBatchPredictionJobAsync(BatchPredictionJobName name) + *
  • deleteBatchPredictionJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteBatchPredictionJobOperationCallable() + *
  • deleteBatchPredictionJobCallable() + *
+ *
CancelBatchPredictionJob

Cancels a BatchPredictionJob. + *

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelBatchPredictionJob(CancelBatchPredictionJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelBatchPredictionJob(BatchPredictionJobName name) + *
  • cancelBatchPredictionJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelBatchPredictionJobCallable() + *
+ *
CreateModelDeploymentMonitoringJob

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createModelDeploymentMonitoringJob(LocationName parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob) + *
  • createModelDeploymentMonitoringJob(String parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createModelDeploymentMonitoringJobCallable() + *
+ *
SearchModelDeploymentMonitoringStatsAnomalies

Searches Model Monitoring Statistics generated within a given time window.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchModelDeploymentMonitoringStatsAnomalies(ModelDeploymentMonitoringJobName modelDeploymentMonitoringJob, String deployedModelId) + *
  • searchModelDeploymentMonitoringStatsAnomalies(String modelDeploymentMonitoringJob, String deployedModelId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchModelDeploymentMonitoringStatsAnomaliesPagedCallable() + *
  • searchModelDeploymentMonitoringStatsAnomaliesCallable() + *
+ *
GetModelDeploymentMonitoringJob

Gets a ModelDeploymentMonitoringJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name) + *
  • getModelDeploymentMonitoringJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelDeploymentMonitoringJobCallable() + *
+ *
ListModelDeploymentMonitoringJobs

Lists ModelDeploymentMonitoringJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelDeploymentMonitoringJobs(LocationName parent) + *
  • listModelDeploymentMonitoringJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelDeploymentMonitoringJobsPagedCallable() + *
  • listModelDeploymentMonitoringJobsCallable() + *
+ *
UpdateModelDeploymentMonitoringJob

Updates a ModelDeploymentMonitoringJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateModelDeploymentMonitoringJobOperationCallable() + *
  • updateModelDeploymentMonitoringJobCallable() + *
+ *
DeleteModelDeploymentMonitoringJob

Deletes a ModelDeploymentMonitoringJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJobName name) + *
  • deleteModelDeploymentMonitoringJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelDeploymentMonitoringJobOperationCallable() + *
  • deleteModelDeploymentMonitoringJobCallable() + *
+ *
PauseModelDeploymentMonitoringJob

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • pauseModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name) + *
  • pauseModelDeploymentMonitoringJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • pauseModelDeploymentMonitoringJobCallable() + *
+ *
ResumeModelDeploymentMonitoringJob

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • resumeModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name) + *
  • resumeModelDeploymentMonitoringJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • resumeModelDeploymentMonitoringJobCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/LlmUtilityServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/LlmUtilityServiceClient.java index 6cb476fc72f5..3682d4ad06d7 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/LlmUtilityServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/LlmUtilityServiceClient.java @@ -68,19 +68,105 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ComputeTokens

Return a list of tokens based on the input text.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • computeTokens(ComputeTokensRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • computeTokens(EndpointName endpoint, List instances) + *
  • computeTokens(String endpoint, List instances) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • computeTokensCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MatchServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MatchServiceClient.java index dab8fba70eb4..209071a4c26b 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MatchServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MatchServiceClient.java @@ -72,19 +72,114 @@ *

Note: close() needs to be called on the MatchServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
FindNeighbors

Finds the nearest neighbors of each vector within the request.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • findNeighbors(FindNeighborsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • findNeighborsCallable() + *
+ *
ReadIndexDatapoints

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readIndexDatapoints(ReadIndexDatapointsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readIndexDatapointsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MetadataServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MetadataServiceClient.java index d877a7a7e470..1dbdec1260b4 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MetadataServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MetadataServiceClient.java @@ -71,19 +71,704 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateMetadataStore

Initializes a MetadataStore, including allocation of resources.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createMetadataStoreAsync(CreateMetadataStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createMetadataStoreAsync(LocationName parent, MetadataStore metadataStore, String metadataStoreId) + *
  • createMetadataStoreAsync(String parent, MetadataStore metadataStore, String metadataStoreId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createMetadataStoreOperationCallable() + *
  • createMetadataStoreCallable() + *
+ *
GetMetadataStore

Retrieves a specific MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMetadataStore(GetMetadataStoreRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMetadataStore(MetadataStoreName name) + *
  • getMetadataStore(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMetadataStoreCallable() + *
+ *
ListMetadataStores

Lists MetadataStores for a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listMetadataStores(ListMetadataStoresRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listMetadataStores(LocationName parent) + *
  • listMetadataStores(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listMetadataStoresPagedCallable() + *
  • listMetadataStoresCallable() + *
+ *
DeleteMetadataStore

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteMetadataStoreAsync(DeleteMetadataStoreRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteMetadataStoreAsync(MetadataStoreName name) + *
  • deleteMetadataStoreAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteMetadataStoreOperationCallable() + *
  • deleteMetadataStoreCallable() + *
+ *
CreateArtifact

Creates an Artifact associated with a MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createArtifact(CreateArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createArtifact(MetadataStoreName parent, Artifact artifact, String artifactId) + *
  • createArtifact(String parent, Artifact artifact, String artifactId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createArtifactCallable() + *
+ *
GetArtifact

Retrieves a specific Artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getArtifact(GetArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getArtifact(ArtifactName name) + *
  • getArtifact(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getArtifactCallable() + *
+ *
ListArtifacts

Lists Artifacts in the MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listArtifacts(ListArtifactsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listArtifacts(MetadataStoreName parent) + *
  • listArtifacts(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listArtifactsPagedCallable() + *
  • listArtifactsCallable() + *
+ *
UpdateArtifact

Updates a stored Artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateArtifact(UpdateArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateArtifact(Artifact artifact, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateArtifactCallable() + *
+ *
DeleteArtifact

Deletes an Artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteArtifactAsync(DeleteArtifactRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteArtifactAsync(ArtifactName name) + *
  • deleteArtifactAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteArtifactOperationCallable() + *
  • deleteArtifactCallable() + *
+ *
PurgeArtifacts

Purges Artifacts.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • purgeArtifactsAsync(PurgeArtifactsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • purgeArtifactsAsync(MetadataStoreName parent) + *
  • purgeArtifactsAsync(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • purgeArtifactsOperationCallable() + *
  • purgeArtifactsCallable() + *
+ *
CreateContext

Creates a Context associated with a MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createContext(CreateContextRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createContext(MetadataStoreName parent, Context context, String contextId) + *
  • createContext(String parent, Context context, String contextId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createContextCallable() + *
+ *
GetContext

Retrieves a specific Context.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getContext(GetContextRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getContext(ContextName name) + *
  • getContext(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getContextCallable() + *
+ *
ListContexts

Lists Contexts on the MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listContexts(ListContextsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listContexts(MetadataStoreName parent) + *
  • listContexts(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listContextsPagedCallable() + *
  • listContextsCallable() + *
+ *
UpdateContext

Updates a stored Context.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateContext(UpdateContextRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateContext(Context context, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateContextCallable() + *
+ *
DeleteContext

Deletes a stored Context.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteContextAsync(DeleteContextRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteContextAsync(ContextName name) + *
  • deleteContextAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteContextOperationCallable() + *
  • deleteContextCallable() + *
+ *
PurgeContexts

Purges Contexts.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • purgeContextsAsync(PurgeContextsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • purgeContextsAsync(MetadataStoreName parent) + *
  • purgeContextsAsync(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • purgeContextsOperationCallable() + *
  • purgeContextsCallable() + *
+ *
AddContextArtifactsAndExecutions

Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • addContextArtifactsAndExecutions(ContextName context, List artifacts, List executions) + *
  • addContextArtifactsAndExecutions(String context, List artifacts, List executions) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addContextArtifactsAndExecutionsCallable() + *
+ *
AddContextChildren

Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addContextChildren(AddContextChildrenRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • addContextChildren(ContextName context, List childContexts) + *
  • addContextChildren(String context, List childContexts) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addContextChildrenCallable() + *
+ *
RemoveContextChildren

Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • removeContextChildren(RemoveContextChildrenRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • removeContextChildren(ContextName context, List childContexts) + *
  • removeContextChildren(String context, List childContexts) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • removeContextChildrenCallable() + *
+ *
QueryContextLineageSubgraph

Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryContextLineageSubgraph(QueryContextLineageSubgraphRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryContextLineageSubgraph(ContextName context) + *
  • queryContextLineageSubgraph(String context) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryContextLineageSubgraphCallable() + *
+ *
CreateExecution

Creates an Execution associated with a MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createExecution(CreateExecutionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createExecution(MetadataStoreName parent, Execution execution, String executionId) + *
  • createExecution(String parent, Execution execution, String executionId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createExecutionCallable() + *
+ *
GetExecution

Retrieves a specific Execution.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getExecution(GetExecutionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getExecution(ExecutionName name) + *
  • getExecution(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getExecutionCallable() + *
+ *
ListExecutions

Lists Executions in the MetadataStore.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listExecutions(ListExecutionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listExecutions(MetadataStoreName parent) + *
  • listExecutions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listExecutionsPagedCallable() + *
  • listExecutionsCallable() + *
+ *
UpdateExecution

Updates a stored Execution.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateExecution(UpdateExecutionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateExecution(Execution execution, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateExecutionCallable() + *
+ *
DeleteExecution

Deletes an Execution.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteExecutionAsync(DeleteExecutionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteExecutionAsync(ExecutionName name) + *
  • deleteExecutionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteExecutionOperationCallable() + *
  • deleteExecutionCallable() + *
+ *
PurgeExecutions

Purges Executions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • purgeExecutionsAsync(PurgeExecutionsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • purgeExecutionsAsync(MetadataStoreName parent) + *
  • purgeExecutionsAsync(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • purgeExecutionsOperationCallable() + *
  • purgeExecutionsCallable() + *
+ *
AddExecutionEvents

Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addExecutionEvents(AddExecutionEventsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • addExecutionEvents(ExecutionName execution, List events) + *
  • addExecutionEvents(String execution, List events) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addExecutionEventsCallable() + *
+ *
QueryExecutionInputsAndOutputs

Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryExecutionInputsAndOutputs(ExecutionName execution) + *
  • queryExecutionInputsAndOutputs(String execution) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryExecutionInputsAndOutputsCallable() + *
+ *
CreateMetadataSchema

Creates a MetadataSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createMetadataSchema(CreateMetadataSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createMetadataSchema(MetadataStoreName parent, MetadataSchema metadataSchema, String metadataSchemaId) + *
  • createMetadataSchema(String parent, MetadataSchema metadataSchema, String metadataSchemaId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createMetadataSchemaCallable() + *
+ *
GetMetadataSchema

Retrieves a specific MetadataSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMetadataSchema(GetMetadataSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMetadataSchema(MetadataSchemaName name) + *
  • getMetadataSchema(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMetadataSchemaCallable() + *
+ *
ListMetadataSchemas

Lists MetadataSchemas.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listMetadataSchemas(ListMetadataSchemasRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listMetadataSchemas(MetadataStoreName parent) + *
  • listMetadataSchemas(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listMetadataSchemasPagedCallable() + *
  • listMetadataSchemasCallable() + *
+ *
QueryArtifactLineageSubgraph

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryArtifactLineageSubgraph(ArtifactName artifact) + *
  • queryArtifactLineageSubgraph(String artifact) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryArtifactLineageSubgraphCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MigrationServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MigrationServiceClient.java index 8177b2cfddcd..4a3db34fa4ca 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MigrationServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MigrationServiceClient.java @@ -70,19 +70,126 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
SearchMigratableResources

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchMigratableResources(SearchMigratableResourcesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchMigratableResources(LocationName parent) + *
  • searchMigratableResources(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchMigratableResourcesPagedCallable() + *
  • searchMigratableResourcesCallable() + *
+ *
BatchMigrateResources

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchMigrateResourcesAsync(BatchMigrateResourcesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchMigrateResourcesAsync(LocationName parent, List migrateResourceRequests) + *
  • batchMigrateResourcesAsync(String parent, List migrateResourceRequests) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchMigrateResourcesOperationCallable() + *
  • batchMigrateResourcesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelGardenServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelGardenServiceClient.java index 53d4b041163a..df6f08847c18 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelGardenServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelGardenServiceClient.java @@ -65,19 +65,124 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
GetPublisherModel

Gets a Model Garden publisher model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPublisherModel(GetPublisherModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPublisherModel(PublisherModelName name) + *
  • getPublisherModel(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPublisherModelCallable() + *
+ *
ListPublisherModels

Lists publisher models in Model Garden.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listPublisherModels(ListPublisherModelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listPublisherModels(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPublisherModelsPagedCallable() + *
  • listPublisherModelsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelServiceClient.java index 10fd61183a4f..5d372eef7304 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ModelServiceClient.java @@ -70,19 +70,441 @@ *

Note: close() needs to be called on the ModelServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
UploadModel

Uploads a Model artifact into Vertex AI.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • uploadModelAsync(UploadModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • uploadModelAsync(LocationName parent, Model model) + *
  • uploadModelAsync(String parent, Model model) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • uploadModelOperationCallable() + *
  • uploadModelCallable() + *
+ *
GetModel

Gets a Model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModel(GetModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModel(ModelName name) + *
  • getModel(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelCallable() + *
+ *
ListModels

Lists Models in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModels(ListModelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModels(LocationName parent) + *
  • listModels(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelsPagedCallable() + *
  • listModelsCallable() + *
+ *
ListModelVersions

Lists versions of the specified model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelVersions(ListModelVersionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelVersions(ModelName name) + *
  • listModelVersions(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelVersionsPagedCallable() + *
  • listModelVersionsCallable() + *
+ *
UpdateModel

Updates a Model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateModel(UpdateModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateModel(Model model, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateModelCallable() + *
+ *
UpdateExplanationDataset

Incrementally update the dataset used for an examples model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateExplanationDatasetAsync(UpdateExplanationDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateExplanationDatasetAsync(ModelName model) + *
  • updateExplanationDatasetAsync(String model) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateExplanationDatasetOperationCallable() + *
  • updateExplanationDatasetCallable() + *
+ *
DeleteModel

Deletes a Model. + *

A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] field.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelAsync(DeleteModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelAsync(ModelName name) + *
  • deleteModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelOperationCallable() + *
  • deleteModelCallable() + *
+ *
DeleteModelVersion

Deletes a Model version. + *

Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1beta1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel] for deleting the Model instead.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelVersionAsync(DeleteModelVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelVersionAsync(ModelName name) + *
  • deleteModelVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelVersionOperationCallable() + *
  • deleteModelVersionCallable() + *
+ *
MergeVersionAliases

Merges a set of aliases for a Model version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • mergeVersionAliases(MergeVersionAliasesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • mergeVersionAliases(ModelName name, List versionAliases) + *
  • mergeVersionAliases(String name, List versionAliases) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • mergeVersionAliasesCallable() + *
+ *
ExportModel

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1beta1.Model.supported_export_formats].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportModelAsync(ExportModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportModelAsync(ModelName name, ExportModelRequest.OutputConfig outputConfig) + *
  • exportModelAsync(String name, ExportModelRequest.OutputConfig outputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportModelOperationCallable() + *
  • exportModelCallable() + *
+ *
CopyModel

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1beta1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • copyModelAsync(CopyModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • copyModelAsync(LocationName parent, ModelName sourceModel) + *
  • copyModelAsync(LocationName parent, String sourceModel) + *
  • copyModelAsync(String parent, ModelName sourceModel) + *
  • copyModelAsync(String parent, String sourceModel) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • copyModelOperationCallable() + *
  • copyModelCallable() + *
+ *
ImportModelEvaluation

Imports an externally generated ModelEvaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importModelEvaluation(ImportModelEvaluationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • importModelEvaluation(ModelName parent, ModelEvaluation modelEvaluation) + *
  • importModelEvaluation(String parent, ModelEvaluation modelEvaluation) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importModelEvaluationCallable() + *
+ *
BatchImportModelEvaluationSlices

Imports a list of externally generated ModelEvaluationSlice.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • batchImportModelEvaluationSlices(ModelEvaluationName parent, List modelEvaluationSlices) + *
  • batchImportModelEvaluationSlices(String parent, List modelEvaluationSlices) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchImportModelEvaluationSlicesCallable() + *
+ *
BatchImportEvaluatedAnnotations

Imports a list of externally generated EvaluatedAnnotations.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • batchImportEvaluatedAnnotations(ModelEvaluationSliceName parent, List evaluatedAnnotations) + *
  • batchImportEvaluatedAnnotations(String parent, List evaluatedAnnotations) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchImportEvaluatedAnnotationsCallable() + *
+ *
GetModelEvaluation

Gets a ModelEvaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelEvaluation(GetModelEvaluationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelEvaluation(ModelEvaluationName name) + *
  • getModelEvaluation(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelEvaluationCallable() + *
+ *
ListModelEvaluations

Lists ModelEvaluations in a Model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelEvaluations(ListModelEvaluationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelEvaluations(ModelName parent) + *
  • listModelEvaluations(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelEvaluationsPagedCallable() + *
  • listModelEvaluationsCallable() + *
+ *
GetModelEvaluationSlice

Gets a ModelEvaluationSlice.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelEvaluationSlice(GetModelEvaluationSliceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelEvaluationSlice(ModelEvaluationSliceName name) + *
  • getModelEvaluationSlice(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelEvaluationSliceCallable() + *
+ *
ListModelEvaluationSlices

Lists ModelEvaluationSlices in a ModelEvaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelEvaluationSlices(ListModelEvaluationSlicesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelEvaluationSlices(ModelEvaluationName parent) + *
  • listModelEvaluationSlices(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelEvaluationSlicesPagedCallable() + *
  • listModelEvaluationSlicesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PersistentResourceServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PersistentResourceServiceClient.java index 1ea5ce728d8d..ddb6de7e9cda 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PersistentResourceServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PersistentResourceServiceClient.java @@ -73,19 +73,184 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreatePersistentResource

Creates a PersistentResource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createPersistentResourceAsync(CreatePersistentResourceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createPersistentResourceAsync(LocationName parent, PersistentResource persistentResource, String persistentResourceId) + *
  • createPersistentResourceAsync(String parent, PersistentResource persistentResource, String persistentResourceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createPersistentResourceOperationCallable() + *
  • createPersistentResourceCallable() + *
+ *
GetPersistentResource

Gets a PersistentResource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPersistentResource(GetPersistentResourceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPersistentResource(PersistentResourceName name) + *
  • getPersistentResource(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPersistentResourceCallable() + *
+ *
ListPersistentResources

Lists PersistentResources in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listPersistentResources(ListPersistentResourcesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listPersistentResources(LocationName parent) + *
  • listPersistentResources(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPersistentResourcesPagedCallable() + *
  • listPersistentResourcesCallable() + *
+ *
DeletePersistentResource

Deletes a PersistentResource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deletePersistentResourceAsync(DeletePersistentResourceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deletePersistentResourceAsync(PersistentResourceName name) + *
  • deletePersistentResourceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deletePersistentResourceOperationCallable() + *
  • deletePersistentResourceCallable() + *
+ *
UpdatePersistentResource

Updates a PersistentResource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updatePersistentResourceAsync(UpdatePersistentResourceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updatePersistentResourceAsync(PersistentResource persistentResource, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updatePersistentResourceOperationCallable() + *
  • updatePersistentResourceCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PipelineServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PipelineServiceClient.java index bec1cce7c146..40c8336d8a47 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PipelineServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PipelineServiceClient.java @@ -74,19 +74,300 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateTrainingPipeline

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTrainingPipeline(CreateTrainingPipelineRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTrainingPipeline(LocationName parent, TrainingPipeline trainingPipeline) + *
  • createTrainingPipeline(String parent, TrainingPipeline trainingPipeline) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTrainingPipelineCallable() + *
+ *
GetTrainingPipeline

Gets a TrainingPipeline.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTrainingPipeline(GetTrainingPipelineRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTrainingPipeline(TrainingPipelineName name) + *
  • getTrainingPipeline(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTrainingPipelineCallable() + *
+ *
ListTrainingPipelines

Lists TrainingPipelines in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTrainingPipelines(ListTrainingPipelinesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTrainingPipelines(LocationName parent) + *
  • listTrainingPipelines(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTrainingPipelinesPagedCallable() + *
  • listTrainingPipelinesCallable() + *
+ *
DeleteTrainingPipeline

Deletes a TrainingPipeline.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTrainingPipelineAsync(TrainingPipelineName name) + *
  • deleteTrainingPipelineAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTrainingPipelineOperationCallable() + *
  • deleteTrainingPipelineCallable() + *
+ *
CancelTrainingPipeline

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1beta1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1beta1.TrainingPipeline.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelTrainingPipeline(CancelTrainingPipelineRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelTrainingPipeline(TrainingPipelineName name) + *
  • cancelTrainingPipeline(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelTrainingPipelineCallable() + *
+ *
CreatePipelineJob

Creates a PipelineJob. A PipelineJob will run immediately when created.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createPipelineJob(CreatePipelineJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createPipelineJob(LocationName parent, PipelineJob pipelineJob, String pipelineJobId) + *
  • createPipelineJob(String parent, PipelineJob pipelineJob, String pipelineJobId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createPipelineJobCallable() + *
+ *
GetPipelineJob

Gets a PipelineJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPipelineJob(GetPipelineJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPipelineJob(PipelineJobName name) + *
  • getPipelineJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPipelineJobCallable() + *
+ *
ListPipelineJobs

Lists PipelineJobs in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listPipelineJobs(ListPipelineJobsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listPipelineJobs(LocationName parent) + *
  • listPipelineJobs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPipelineJobsPagedCallable() + *
  • listPipelineJobsCallable() + *
+ *
DeletePipelineJob

Deletes a PipelineJob.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deletePipelineJobAsync(DeletePipelineJobRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deletePipelineJobAsync(PipelineJobName name) + *
  • deletePipelineJobAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deletePipelineJobOperationCallable() + *
  • deletePipelineJobCallable() + *
+ *
BatchDeletePipelineJobs

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchDeletePipelineJobsAsync(BatchDeletePipelineJobsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchDeletePipelineJobsAsync(LocationName parent, List names) + *
  • batchDeletePipelineJobsAsync(String parent, List names) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchDeletePipelineJobsOperationCallable() + *
  • batchDeletePipelineJobsCallable() + *
+ *
CancelPipelineJob

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1beta1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1beta1.PipelineJob.state] is set to `CANCELLED`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelPipelineJob(CancelPipelineJobRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • cancelPipelineJob(PipelineJobName name) + *
  • cancelPipelineJob(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelPipelineJobCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PredictionServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PredictionServiceClient.java index ed0192633227..f34b4fb7323d 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PredictionServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/PredictionServiceClient.java @@ -72,19 +72,238 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
Predict

Perform an online prediction.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • predict(PredictRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • predict(EndpointName endpoint, List instances, Value parameters) + *
  • predict(String endpoint, List instances, Value parameters) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • predictCallable() + *
+ *
RawPredict

Perform an online prediction with an arbitrary HTTP payload. + *

The response includes the following HTTP headers: + *

    + *
  • `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this prediction. + *
+ *
    + *
  • `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] that served this prediction. + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • rawPredict(RawPredictRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • rawPredict(EndpointName endpoint, HttpBody httpBody) + *
  • rawPredict(String endpoint, HttpBody httpBody) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • rawPredictCallable() + *
+ *
DirectPredict

Perform an unary online prediction request for Vertex first-party products and frameworks.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • directPredict(DirectPredictRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • directPredictCallable() + *
+ *
DirectRawPredict

Perform an online prediction request through gRPC.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • directRawPredict(DirectRawPredictRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • directRawPredictCallable() + *
+ *
StreamingPredict

Perform a streaming online prediction request for Vertex first-party products and frameworks.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamingPredictCallable() + *
+ *
ServerStreamingPredict

Perform a server-side streaming online prediction request for Vertex LLM streaming.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • serverStreamingPredictCallable() + *
+ *
StreamingRawPredict

Perform a streaming online prediction request through gRPC.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamingRawPredictCallable() + *
+ *
Explain

Perform an online explanation. + *

If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is specified, the corresponding DeployModel must have [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] populated. If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is not specified, all DeployedModels must have [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] populated.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • explain(ExplainRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • explain(EndpointName endpoint, List instances, Value parameters, String deployedModelId) + *
  • explain(String endpoint, List instances, Value parameters, String deployedModelId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • explainCallable() + *
+ *
CountTokens

Perform a token counting.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • countTokens(CountTokensRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • countTokens(EndpointName endpoint, List instances) + *
  • countTokens(String endpoint, List instances) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • countTokensCallable() + *
+ *
StreamGenerateContent

Generate content with multimodal inputs with streaming support.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • streamGenerateContentCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ScheduleServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ScheduleServiceClient.java index 91accf003c6f..b5df0ed7e79d 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ScheduleServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/ScheduleServiceClient.java @@ -73,19 +73,224 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateSchedule

Creates a Schedule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSchedule(CreateScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createSchedule(LocationName parent, Schedule schedule) + *
  • createSchedule(String parent, Schedule schedule) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createScheduleCallable() + *
+ *
DeleteSchedule

Deletes a Schedule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteScheduleAsync(DeleteScheduleRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteScheduleAsync(ScheduleName name) + *
  • deleteScheduleAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteScheduleOperationCallable() + *
  • deleteScheduleCallable() + *
+ *
GetSchedule

Gets a Schedule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSchedule(GetScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSchedule(ScheduleName name) + *
  • getSchedule(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getScheduleCallable() + *
+ *
ListSchedules

Lists Schedules in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSchedules(ListSchedulesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSchedules(LocationName parent) + *
  • listSchedules(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSchedulesPagedCallable() + *
  • listSchedulesCallable() + *
+ *
PauseSchedule

Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1beta1.Schedule.state] to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • pauseSchedule(PauseScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • pauseSchedule(ScheduleName name) + *
  • pauseSchedule(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • pauseScheduleCallable() + *
+ *
ResumeSchedule

Resumes a paused Schedule to start scheduling new runs. Will mark [Schedule.state][google.cloud.aiplatform.v1beta1.Schedule.state] to 'ACTIVE'. Only paused Schedule can be resumed. + *

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • resumeSchedule(ResumeScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • resumeSchedule(ScheduleName name) + *
  • resumeSchedule(String name) + *
  • resumeSchedule(ScheduleName name, boolean catchUp) + *
  • resumeSchedule(String name, boolean catchUp) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • resumeScheduleCallable() + *
+ *
UpdateSchedule

Updates an active or paused Schedule. + *

When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSchedule(UpdateScheduleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateSchedule(Schedule schedule, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateScheduleCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/SpecialistPoolServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/SpecialistPoolServiceClient.java index 285c05eb3211..ada966441064 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/SpecialistPoolServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/SpecialistPoolServiceClient.java @@ -77,19 +77,184 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateSpecialistPool

Creates a SpecialistPool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSpecialistPoolAsync(CreateSpecialistPoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSpecialistPoolAsync(LocationName parent, SpecialistPool specialistPool) + *
  • createSpecialistPoolAsync(String parent, SpecialistPool specialistPool) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSpecialistPoolOperationCallable() + *
  • createSpecialistPoolCallable() + *
+ *
GetSpecialistPool

Gets a SpecialistPool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSpecialistPool(GetSpecialistPoolRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSpecialistPool(SpecialistPoolName name) + *
  • getSpecialistPool(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSpecialistPoolCallable() + *
+ *
ListSpecialistPools

Lists SpecialistPools in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSpecialistPools(ListSpecialistPoolsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSpecialistPools(LocationName parent) + *
  • listSpecialistPools(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSpecialistPoolsPagedCallable() + *
  • listSpecialistPoolsCallable() + *
+ *
DeleteSpecialistPool

Deletes a SpecialistPool as well as all Specialists in the pool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteSpecialistPoolAsync(SpecialistPoolName name) + *
  • deleteSpecialistPoolAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSpecialistPoolOperationCallable() + *
  • deleteSpecialistPoolCallable() + *
+ *
UpdateSpecialistPool

Updates a SpecialistPool.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSpecialistPoolAsync(UpdateSpecialistPoolRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateSpecialistPoolAsync(SpecialistPool specialistPool, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateSpecialistPoolOperationCallable() + *
  • updateSpecialistPoolCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/TensorboardServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/TensorboardServiceClient.java index a60944dca297..cfd2b996f600 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/TensorboardServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/TensorboardServiceClient.java @@ -72,19 +72,648 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateTensorboard

Creates a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardAsync(CreateTensorboardRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createTensorboardAsync(TensorboardName parent, Tensorboard tensorboard) + *
  • createTensorboardAsync(String parent, Tensorboard tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardOperationCallable() + *
  • createTensorboardCallable() + *
+ *
GetTensorboard

Gets a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboard(GetTensorboardRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboard(TensorboardName name) + *
  • getTensorboard(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardCallable() + *
+ *
UpdateTensorboard

Updates a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardAsync(UpdateTensorboardRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateTensorboardAsync(Tensorboard tensorboard, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardOperationCallable() + *
  • updateTensorboardCallable() + *
+ *
ListTensorboards

Lists Tensorboards in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboards(ListTensorboardsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboards(LocationName parent) + *
  • listTensorboards(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardsPagedCallable() + *
  • listTensorboardsCallable() + *
+ *
DeleteTensorboard

Deletes a Tensorboard.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardAsync(DeleteTensorboardRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardAsync(TensorboardName name) + *
  • deleteTensorboardAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardOperationCallable() + *
  • deleteTensorboardCallable() + *
+ *
ReadTensorboardUsage

Returns a list of monthly active users for a given TensorBoard instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readTensorboardUsage(ReadTensorboardUsageRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readTensorboardUsage(TensorboardName tensorboard) + *
  • readTensorboardUsage(String tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardUsageCallable() + *
+ *
ReadTensorboardSize

Returns the storage size for a given TensorBoard instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readTensorboardSize(ReadTensorboardSizeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readTensorboardSize(TensorboardName tensorboard) + *
  • readTensorboardSize(String tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardSizeCallable() + *
+ *
CreateTensorboardExperiment

Creates a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardExperiment(CreateTensorboardExperimentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTensorboardExperiment(TensorboardExperimentName parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId) + *
  • createTensorboardExperiment(String parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardExperimentCallable() + *
+ *
GetTensorboardExperiment

Gets a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboardExperiment(GetTensorboardExperimentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboardExperiment(TensorboardExperimentName name) + *
  • getTensorboardExperiment(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardExperimentCallable() + *
+ *
UpdateTensorboardExperiment

Updates a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardExperiment(UpdateTensorboardExperimentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTensorboardExperiment(TensorboardExperiment tensorboardExperiment, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardExperimentCallable() + *
+ *
ListTensorboardExperiments

Lists TensorboardExperiments in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboardExperiments(ListTensorboardExperimentsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboardExperiments(TensorboardName parent) + *
  • listTensorboardExperiments(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardExperimentsPagedCallable() + *
  • listTensorboardExperimentsCallable() + *
+ *
DeleteTensorboardExperiment

Deletes a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardExperimentAsync(TensorboardExperimentName name) + *
  • deleteTensorboardExperimentAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardExperimentOperationCallable() + *
  • deleteTensorboardExperimentCallable() + *
+ *
CreateTensorboardRun

Creates a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardRun(CreateTensorboardRunRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTensorboardRun(TensorboardRunName parent, TensorboardRun tensorboardRun, String tensorboardRunId) + *
  • createTensorboardRun(String parent, TensorboardRun tensorboardRun, String tensorboardRunId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardRunCallable() + *
+ *
BatchCreateTensorboardRuns

Batch create TensorboardRuns.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateTensorboardRuns(TensorboardExperimentName parent, List requests) + *
  • batchCreateTensorboardRuns(String parent, List requests) + *
  • batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateTensorboardRunsCallable() + *
+ *
GetTensorboardRun

Gets a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboardRun(GetTensorboardRunRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboardRun(TensorboardRunName name) + *
  • getTensorboardRun(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardRunCallable() + *
+ *
UpdateTensorboardRun

Updates a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardRun(UpdateTensorboardRunRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTensorboardRun(TensorboardRun tensorboardRun, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardRunCallable() + *
+ *
ListTensorboardRuns

Lists TensorboardRuns in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboardRuns(ListTensorboardRunsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboardRuns(TensorboardExperimentName parent) + *
  • listTensorboardRuns(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardRunsPagedCallable() + *
  • listTensorboardRunsCallable() + *
+ *
DeleteTensorboardRun

Deletes a TensorboardRun.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardRunAsync(DeleteTensorboardRunRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardRunAsync(TensorboardRunName name) + *
  • deleteTensorboardRunAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardRunOperationCallable() + *
  • deleteTensorboardRunCallable() + *
+ *
BatchCreateTensorboardTimeSeries

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateTensorboardTimeSeries(TensorboardExperimentName parent, List requests) + *
  • batchCreateTensorboardTimeSeries(String parent, List requests) + *
  • batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateTensorboardTimeSeriesCallable() + *
+ *
CreateTensorboardTimeSeries

Creates a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTensorboardTimeSeries(TensorboardTimeSeriesName parent, TensorboardTimeSeries tensorboardTimeSeries) + *
  • createTensorboardTimeSeries(String parent, TensorboardTimeSeries tensorboardTimeSeries) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTensorboardTimeSeriesCallable() + *
+ *
GetTensorboardTimeSeries

Gets a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTensorboardTimeSeries(TensorboardTimeSeriesName name) + *
  • getTensorboardTimeSeries(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTensorboardTimeSeriesCallable() + *
+ *
UpdateTensorboardTimeSeries

Updates a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTensorboardTimeSeries(TensorboardTimeSeries tensorboardTimeSeries, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTensorboardTimeSeriesCallable() + *
+ *
ListTensorboardTimeSeries

Lists TensorboardTimeSeries in a Location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTensorboardTimeSeries(TensorboardRunName parent) + *
  • listTensorboardTimeSeries(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTensorboardTimeSeriesPagedCallable() + *
  • listTensorboardTimeSeriesCallable() + *
+ *
DeleteTensorboardTimeSeries

Deletes a TensorboardTimeSeries.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name) + *
  • deleteTensorboardTimeSeriesAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTensorboardTimeSeriesOperationCallable() + *
  • deleteTensorboardTimeSeriesCallable() + *
+ *
BatchReadTensorboardTimeSeriesData

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • batchReadTensorboardTimeSeriesData(TensorboardName tensorboard) + *
  • batchReadTensorboardTimeSeriesData(String tensorboard) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchReadTensorboardTimeSeriesDataCallable() + *
+ *
ReadTensorboardTimeSeriesData

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • readTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries) + *
  • readTensorboardTimeSeriesData(String tensorboardTimeSeries) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardTimeSeriesDataCallable() + *
+ *
ReadTensorboardBlobData

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • readTensorboardBlobDataCallable() + *
+ *
WriteTensorboardExperimentData

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • writeTensorboardExperimentData(TensorboardExperimentName tensorboardExperiment, List writeRunDataRequests) + *
  • writeTensorboardExperimentData(String tensorboardExperiment, List writeRunDataRequests) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • writeTensorboardExperimentDataCallable() + *
+ *
WriteTensorboardRunData

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • writeTensorboardRunData(WriteTensorboardRunDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • writeTensorboardRunData(TensorboardRunName tensorboardRun, List timeSeriesData) + *
  • writeTensorboardRunData(String tensorboardRun, List timeSeriesData) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • writeTensorboardRunDataCallable() + *
+ *
ExportTensorboardTimeSeriesData

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • exportTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries) + *
  • exportTensorboardTimeSeriesData(String tensorboardTimeSeries) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportTensorboardTimeSeriesDataPagedCallable() + *
  • exportTensorboardTimeSeriesDataCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/VizierServiceClient.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/VizierServiceClient.java index 2b3a0809a5c5..1a46335a8ee0 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/VizierServiceClient.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/VizierServiceClient.java @@ -73,19 +73,350 @@ *

Note: close() needs to be called on the VizierServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateStudy

Creates a Study. A resource name will be generated after creation of the Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createStudy(CreateStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createStudy(LocationName parent, Study study) + *
  • createStudy(String parent, Study study) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createStudyCallable() + *
+ *
GetStudy

Gets a Study by name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getStudy(GetStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getStudy(StudyName name) + *
  • getStudy(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getStudyCallable() + *
+ *
ListStudies

Lists all the studies in a region for an associated project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listStudies(ListStudiesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listStudies(LocationName parent) + *
  • listStudies(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listStudiesPagedCallable() + *
  • listStudiesCallable() + *
+ *
DeleteStudy

Deletes a Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteStudy(DeleteStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteStudy(StudyName name) + *
  • deleteStudy(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteStudyCallable() + *
+ *
LookupStudy

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • lookupStudy(LookupStudyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • lookupStudy(LocationName parent) + *
  • lookupStudy(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • lookupStudyCallable() + *
+ *
SuggestTrials

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.aiplatform.v1beta1.SuggestTrialsResponse].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • suggestTrialsAsync(SuggestTrialsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • suggestTrialsOperationCallable() + *
  • suggestTrialsCallable() + *
+ *
CreateTrial

Adds a user provided Trial to a Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTrial(CreateTrialRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTrial(StudyName parent, Trial trial) + *
  • createTrial(String parent, Trial trial) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTrialCallable() + *
+ *
GetTrial

Gets a Trial.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTrial(GetTrialRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTrial(TrialName name) + *
  • getTrial(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTrialCallable() + *
+ *
ListTrials

Lists the Trials associated with a Study.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTrials(ListTrialsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTrials(StudyName parent) + *
  • listTrials(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTrialsPagedCallable() + *
  • listTrialsCallable() + *
+ *
AddTrialMeasurement

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • addTrialMeasurement(AddTrialMeasurementRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • addTrialMeasurementCallable() + *
+ *
CompleteTrial

Marks a Trial as complete.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • completeTrial(CompleteTrialRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • completeTrialCallable() + *
+ *
DeleteTrial

Deletes a Trial.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTrial(DeleteTrialRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteTrial(TrialName name) + *
  • deleteTrial(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTrialCallable() + *
+ *
CheckTrialEarlyStoppingState

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse].

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • checkTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • checkTrialEarlyStoppingStateOperationCallable() + *
  • checkTrialEarlyStoppingStateCallable() + *
+ *
StopTrial

Stops a Trial.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • stopTrial(StopTrialRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • stopTrialCallable() + *
+ *
ListOptimalTrials

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listOptimalTrials(ListOptimalTrialsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listOptimalTrials(StudyName parent) + *
  • listOptimalTrials(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listOptimalTrialsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DatasetServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DatasetServiceStubSettings.java index e6e961653f64..0a0aad93fee8 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DatasetServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DatasetServiceStubSettings.java @@ -798,6 +798,12 @@ public DatasetServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DeploymentResourcePoolServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DeploymentResourcePoolServiceStubSettings.java index 71e420159546..6e7b7ab27df1 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DeploymentResourcePoolServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/DeploymentResourcePoolServiceStubSettings.java @@ -433,6 +433,12 @@ public DeploymentResourcePoolServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/EndpointServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/EndpointServiceStubSettings.java index 262d929d0b2e..1e0fce738a19 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/EndpointServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/EndpointServiceStubSettings.java @@ -383,6 +383,12 @@ public EndpointServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreAdminServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreAdminServiceStubSettings.java index 4e844429cea2..ec0c693c392b 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreAdminServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreAdminServiceStubSettings.java @@ -610,6 +610,12 @@ public FeatureOnlineStoreAdminServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreServiceStubSettings.java index b3f89e7a555e..217b28ee4327 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureOnlineStoreServiceStubSettings.java @@ -223,6 +223,12 @@ public FeatureOnlineStoreServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureRegistryServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureRegistryServiceStubSettings.java index 0b476011c9c3..a0d2a0d93c8f 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureRegistryServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeatureRegistryServiceStubSettings.java @@ -464,6 +464,12 @@ public FeatureRegistryServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreOnlineServingServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreOnlineServingServiceStubSettings.java index 861827579dd2..796ae88c0007 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreOnlineServingServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreOnlineServingServiceStubSettings.java @@ -236,6 +236,12 @@ public FeaturestoreOnlineServingServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreServiceStubSettings.java index d2b5eeb0a4c1..51fbfc47214a 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/FeaturestoreServiceStubSettings.java @@ -759,6 +759,12 @@ public FeaturestoreServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexEndpointServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexEndpointServiceStubSettings.java index e12126f49385..31412d959c60 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexEndpointServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexEndpointServiceStubSettings.java @@ -399,6 +399,12 @@ public IndexEndpointServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexServiceStubSettings.java index 76d79f652efb..4ddf08d9ca00 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/IndexServiceStubSettings.java @@ -348,6 +348,12 @@ public IndexServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/JobServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/JobServiceStubSettings.java index 7d7740bf7a7e..f96cf2eec245 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/JobServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/JobServiceStubSettings.java @@ -1192,6 +1192,12 @@ public JobServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/LlmUtilityServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/LlmUtilityServiceStubSettings.java index 41be55cbd0e4..1b3e405fcd85 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/LlmUtilityServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/LlmUtilityServiceStubSettings.java @@ -211,6 +211,12 @@ public LlmUtilityServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MatchServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MatchServiceStubSettings.java index 9af4abfb6333..51f2cdd0d398 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MatchServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MatchServiceStubSettings.java @@ -220,6 +220,12 @@ public MatchServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MetadataServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MetadataServiceStubSettings.java index 63905c24def5..afcaaca85284 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MetadataServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MetadataServiceStubSettings.java @@ -855,6 +855,12 @@ public MetadataServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MigrationServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MigrationServiceStubSettings.java index 9cdf514fa4ff..58cabc068f09 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MigrationServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/MigrationServiceStubSettings.java @@ -325,6 +325,12 @@ public MigrationServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelGardenServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelGardenServiceStubSettings.java index d8c4c38209ed..f2706a57d43c 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelGardenServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelGardenServiceStubSettings.java @@ -285,6 +285,12 @@ public ModelGardenServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelServiceStubSettings.java index d57e59b2b931..6493a4c1e618 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ModelServiceStubSettings.java @@ -704,6 +704,12 @@ public ModelServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PersistentResourceServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PersistentResourceServiceStubSettings.java index cd093bed7bf2..68ed6be672cb 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PersistentResourceServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PersistentResourceServiceStubSettings.java @@ -376,6 +376,12 @@ public PersistentResourceServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PipelineServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PipelineServiceStubSettings.java index 5b9ed0a0bd50..f3bf36a563af 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PipelineServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PipelineServiceStubSettings.java @@ -464,6 +464,12 @@ public PipelineServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PredictionServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PredictionServiceStubSettings.java index 1ce8203a4170..3834d6796222 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PredictionServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/PredictionServiceStubSettings.java @@ -294,6 +294,12 @@ public PredictionServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ScheduleServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ScheduleServiceStubSettings.java index 67625ad87f5b..4e3066b13c43 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ScheduleServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/ScheduleServiceStubSettings.java @@ -325,6 +325,12 @@ public ScheduleServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/SpecialistPoolServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/SpecialistPoolServiceStubSettings.java index 537aa44f9e33..c20e341236e0 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/SpecialistPoolServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/SpecialistPoolServiceStubSettings.java @@ -348,6 +348,12 @@ public SpecialistPoolServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/TensorboardServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/TensorboardServiceStubSettings.java index d69a5d680f77..72d3f7057570 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/TensorboardServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/TensorboardServiceStubSettings.java @@ -940,6 +940,12 @@ public TensorboardServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/VizierServiceStubSettings.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/VizierServiceStubSettings.java index 6083438065af..84cf1f2f288e 100644 --- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/VizierServiceStubSettings.java +++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/stub/VizierServiceStubSettings.java @@ -461,6 +461,12 @@ public VizierServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "aiplatform"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/AlloyDBAdminClient.java b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/AlloyDBAdminClient.java index 9c1d52d96cbe..58b0dedd3e6d 100644 --- a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/AlloyDBAdminClient.java +++ b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/AlloyDBAdminClient.java @@ -65,19 +65,639 @@ *

Note: close() needs to be called on the AlloyDBAdminClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListClusters

Lists Clusters in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listClusters(ListClustersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listClusters(LocationName parent) + *
  • listClusters(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listClustersPagedCallable() + *
  • listClustersCallable() + *
+ *
GetCluster

Gets details of a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCluster(GetClusterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCluster(ClusterName name) + *
  • getCluster(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getClusterCallable() + *
+ *
CreateCluster

Creates a new Cluster in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createClusterAsync(CreateClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createClusterAsync(LocationName parent, Cluster cluster, String clusterId) + *
  • createClusterAsync(String parent, Cluster cluster, String clusterId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createClusterOperationCallable() + *
  • createClusterCallable() + *
+ *
UpdateCluster

Updates the parameters of a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateClusterAsync(UpdateClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateClusterAsync(Cluster cluster, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateClusterOperationCallable() + *
  • updateClusterCallable() + *
+ *
DeleteCluster

Deletes a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteClusterAsync(DeleteClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteClusterAsync(ClusterName name) + *
  • deleteClusterAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteClusterOperationCallable() + *
  • deleteClusterCallable() + *
+ *
PromoteCluster

Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • promoteClusterAsync(PromoteClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • promoteClusterAsync(ClusterName name) + *
  • promoteClusterAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • promoteClusterOperationCallable() + *
  • promoteClusterCallable() + *
+ *
RestoreCluster

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restoreClusterAsync(RestoreClusterRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restoreClusterOperationCallable() + *
  • restoreClusterCallable() + *
+ *
CreateSecondaryCluster

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSecondaryClusterAsync(CreateSecondaryClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSecondaryClusterAsync(LocationName parent, Cluster cluster, String clusterId) + *
  • createSecondaryClusterAsync(String parent, Cluster cluster, String clusterId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSecondaryClusterOperationCallable() + *
  • createSecondaryClusterCallable() + *
+ *
ListInstances

Lists Instances in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listInstances(ListInstancesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listInstances(ClusterName parent) + *
  • listInstances(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listInstancesPagedCallable() + *
  • listInstancesCallable() + *
+ *
GetInstance

Gets details of a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getInstance(GetInstanceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getInstance(InstanceName name) + *
  • getInstance(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getInstanceCallable() + *
+ *
CreateInstance

Creates a new Instance in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createInstanceAsync(CreateInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createInstanceAsync(ClusterName parent, Instance instance, String instanceId) + *
  • createInstanceAsync(String parent, Instance instance, String instanceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createInstanceOperationCallable() + *
  • createInstanceCallable() + *
+ *
CreateSecondaryInstance

Creates a new SECONDARY Instance in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSecondaryInstanceAsync(CreateSecondaryInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSecondaryInstanceAsync(ClusterName parent, Instance instance, String instanceId) + *
  • createSecondaryInstanceAsync(String parent, Instance instance, String instanceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSecondaryInstanceOperationCallable() + *
  • createSecondaryInstanceCallable() + *
+ *
BatchCreateInstances

Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateInstancesAsync(BatchCreateInstancesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateInstancesOperationCallable() + *
  • batchCreateInstancesCallable() + *
+ *
UpdateInstance

Updates the parameters of a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateInstanceAsync(UpdateInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateInstanceAsync(Instance instance, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateInstanceOperationCallable() + *
  • updateInstanceCallable() + *
+ *
DeleteInstance

Deletes a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteInstanceAsync(DeleteInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteInstanceAsync(InstanceName name) + *
  • deleteInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteInstanceOperationCallable() + *
  • deleteInstanceCallable() + *
+ *
FailoverInstance

Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • failoverInstanceAsync(FailoverInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • failoverInstanceAsync(InstanceName name) + *
  • failoverInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • failoverInstanceOperationCallable() + *
  • failoverInstanceCallable() + *
+ *
InjectFault

Injects fault in an instance. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • injectFaultAsync(InjectFaultRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • injectFaultAsync(InjectFaultRequest.FaultType faultType, InstanceName name) + *
  • injectFaultAsync(InjectFaultRequest.FaultType faultType, String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • injectFaultOperationCallable() + *
  • injectFaultCallable() + *
+ *
RestartInstance

Restart an Instance in a cluster. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restartInstanceAsync(RestartInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • restartInstanceAsync(InstanceName name) + *
  • restartInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restartInstanceOperationCallable() + *
  • restartInstanceCallable() + *
+ *
ListBackups

Lists Backups in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listBackups(ListBackupsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listBackups(LocationName parent) + *
  • listBackups(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listBackupsPagedCallable() + *
  • listBackupsCallable() + *
+ *
GetBackup

Gets details of a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getBackup(GetBackupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getBackup(BackupName name) + *
  • getBackup(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getBackupCallable() + *
+ *
CreateBackup

Creates a new Backup in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createBackupAsync(CreateBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createBackupAsync(LocationName parent, Backup backup, String backupId) + *
  • createBackupAsync(String parent, Backup backup, String backupId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createBackupOperationCallable() + *
  • createBackupCallable() + *
+ *
UpdateBackup

Updates the parameters of a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateBackupAsync(UpdateBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateBackupAsync(Backup backup, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateBackupOperationCallable() + *
  • updateBackupCallable() + *
+ *
DeleteBackup

Deletes a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteBackupAsync(DeleteBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteBackupAsync(BackupName name) + *
  • deleteBackupAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteBackupOperationCallable() + *
  • deleteBackupCallable() + *
+ *
ListSupportedDatabaseFlags

Lists SupportedDatabaseFlags for a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSupportedDatabaseFlags(LocationName parent) + *
  • listSupportedDatabaseFlags(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSupportedDatabaseFlagsPagedCallable() + *
  • listSupportedDatabaseFlagsCallable() + *
+ *
GenerateClientCertificate

Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • generateClientCertificate(GenerateClientCertificateRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • generateClientCertificate(ClusterName parent) + *
  • generateClientCertificate(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • generateClientCertificateCallable() + *
+ *
GetConnectionInfo

Get instance metadata used for a connection.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getConnectionInfo(GetConnectionInfoRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getConnectionInfo(InstanceName parent) + *
  • getConnectionInfo(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getConnectionInfoCallable() + *
+ *
ListUsers

Lists Users in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listUsers(ListUsersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listUsers(ClusterName parent) + *
  • listUsers(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listUsersPagedCallable() + *
  • listUsersCallable() + *
+ *
GetUser

Gets details of a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getUser(GetUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getUser(UserName name) + *
  • getUser(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getUserCallable() + *
+ *
CreateUser

Creates a new User in a given project, location, and cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createUser(CreateUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createUser(ClusterName parent, User user, String userId) + *
  • createUser(String parent, User user, String userId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createUserCallable() + *
+ *
UpdateUser

Updates the parameters of a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateUser(UpdateUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateUser(User user, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateUserCallable() + *
+ *
DeleteUser

Deletes a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteUser(DeleteUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteUser(UserName name) + *
  • deleteUser(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteUserCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/stub/AlloyDBAdminStubSettings.java b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/stub/AlloyDBAdminStubSettings.java index 39ddce916413..d82a63fa2653 100644 --- a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/stub/AlloyDBAdminStubSettings.java +++ b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1/stub/AlloyDBAdminStubSettings.java @@ -880,6 +880,12 @@ public AlloyDBAdminStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "alloydb"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/AlloyDBAdminClient.java b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/AlloyDBAdminClient.java index 8d649e867afe..025f6e01af1a 100644 --- a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/AlloyDBAdminClient.java +++ b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/AlloyDBAdminClient.java @@ -65,19 +65,659 @@ *

Note: close() needs to be called on the AlloyDBAdminClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListClusters

Lists Clusters in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listClusters(ListClustersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listClusters(LocationName parent) + *
  • listClusters(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listClustersPagedCallable() + *
  • listClustersCallable() + *
+ *
GetCluster

Gets details of a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCluster(GetClusterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCluster(ClusterName name) + *
  • getCluster(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getClusterCallable() + *
+ *
CreateCluster

Creates a new Cluster in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createClusterAsync(CreateClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createClusterAsync(LocationName parent, Cluster cluster, String clusterId) + *
  • createClusterAsync(String parent, Cluster cluster, String clusterId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createClusterOperationCallable() + *
  • createClusterCallable() + *
+ *
UpdateCluster

Updates the parameters of a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateClusterAsync(UpdateClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateClusterAsync(Cluster cluster, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateClusterOperationCallable() + *
  • updateClusterCallable() + *
+ *
DeleteCluster

Deletes a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteClusterAsync(DeleteClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteClusterAsync(ClusterName name) + *
  • deleteClusterAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteClusterOperationCallable() + *
  • deleteClusterCallable() + *
+ *
PromoteCluster

Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • promoteClusterAsync(PromoteClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • promoteClusterAsync(ClusterName name) + *
  • promoteClusterAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • promoteClusterOperationCallable() + *
  • promoteClusterCallable() + *
+ *
RestoreCluster

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restoreClusterAsync(RestoreClusterRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restoreClusterOperationCallable() + *
  • restoreClusterCallable() + *
+ *
CreateSecondaryCluster

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSecondaryClusterAsync(CreateSecondaryClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSecondaryClusterAsync(LocationName parent, Cluster cluster, String clusterId) + *
  • createSecondaryClusterAsync(String parent, Cluster cluster, String clusterId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSecondaryClusterOperationCallable() + *
  • createSecondaryClusterCallable() + *
+ *
ListInstances

Lists Instances in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listInstances(ListInstancesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listInstances(ClusterName parent) + *
  • listInstances(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listInstancesPagedCallable() + *
  • listInstancesCallable() + *
+ *
GetInstance

Gets details of a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getInstance(GetInstanceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getInstance(InstanceName name) + *
  • getInstance(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getInstanceCallable() + *
+ *
CreateInstance

Creates a new Instance in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createInstanceAsync(CreateInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createInstanceAsync(ClusterName parent, Instance instance, String instanceId) + *
  • createInstanceAsync(String parent, Instance instance, String instanceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createInstanceOperationCallable() + *
  • createInstanceCallable() + *
+ *
CreateSecondaryInstance

Creates a new SECONDARY Instance in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSecondaryInstanceAsync(CreateSecondaryInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSecondaryInstanceAsync(ClusterName parent, Instance instance, String instanceId) + *
  • createSecondaryInstanceAsync(String parent, Instance instance, String instanceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSecondaryInstanceOperationCallable() + *
  • createSecondaryInstanceCallable() + *
+ *
BatchCreateInstances

Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateInstancesAsync(BatchCreateInstancesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateInstancesOperationCallable() + *
  • batchCreateInstancesCallable() + *
+ *
UpdateInstance

Updates the parameters of a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateInstanceAsync(UpdateInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateInstanceAsync(Instance instance, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateInstanceOperationCallable() + *
  • updateInstanceCallable() + *
+ *
DeleteInstance

Deletes a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteInstanceAsync(DeleteInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteInstanceAsync(InstanceName name) + *
  • deleteInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteInstanceOperationCallable() + *
  • deleteInstanceCallable() + *
+ *
FailoverInstance

Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • failoverInstanceAsync(FailoverInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • failoverInstanceAsync(InstanceName name) + *
  • failoverInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • failoverInstanceOperationCallable() + *
  • failoverInstanceCallable() + *
+ *
InjectFault

Injects fault in an instance. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • injectFaultAsync(InjectFaultRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • injectFaultAsync(InjectFaultRequest.FaultType faultType, InstanceName name) + *
  • injectFaultAsync(InjectFaultRequest.FaultType faultType, String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • injectFaultOperationCallable() + *
  • injectFaultCallable() + *
+ *
RestartInstance

Restart an Instance in a cluster. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restartInstanceAsync(RestartInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • restartInstanceAsync(InstanceName name) + *
  • restartInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restartInstanceOperationCallable() + *
  • restartInstanceCallable() + *
+ *
ListBackups

Lists Backups in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listBackups(ListBackupsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listBackups(LocationName parent) + *
  • listBackups(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listBackupsPagedCallable() + *
  • listBackupsCallable() + *
+ *
GetBackup

Gets details of a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getBackup(GetBackupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getBackup(BackupName name) + *
  • getBackup(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getBackupCallable() + *
+ *
CreateBackup

Creates a new Backup in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createBackupAsync(CreateBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createBackupAsync(LocationName parent, Backup backup, String backupId) + *
  • createBackupAsync(String parent, Backup backup, String backupId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createBackupOperationCallable() + *
  • createBackupCallable() + *
+ *
UpdateBackup

Updates the parameters of a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateBackupAsync(UpdateBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateBackupAsync(Backup backup, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateBackupOperationCallable() + *
  • updateBackupCallable() + *
+ *
DeleteBackup

Deletes a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteBackupAsync(DeleteBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteBackupAsync(BackupName name) + *
  • deleteBackupAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteBackupOperationCallable() + *
  • deleteBackupCallable() + *
+ *
ListSupportedDatabaseFlags

Lists SupportedDatabaseFlags for a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSupportedDatabaseFlags(LocationName parent) + *
  • listSupportedDatabaseFlags(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSupportedDatabaseFlagsPagedCallable() + *
  • listSupportedDatabaseFlagsCallable() + *
+ *
GenerateClientCertificate

Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • generateClientCertificate(GenerateClientCertificateRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • generateClientCertificate(ClusterName parent) + *
  • generateClientCertificate(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • generateClientCertificateCallable() + *
+ *
GetConnectionInfo

Get instance metadata used for a connection.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getConnectionInfo(GetConnectionInfoRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getConnectionInfo(InstanceName parent) + *
  • getConnectionInfo(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getConnectionInfoCallable() + *
+ *
ListUsers

Lists Users in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listUsers(ListUsersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listUsers(ClusterName parent) + *
  • listUsers(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listUsersPagedCallable() + *
  • listUsersCallable() + *
+ *
GetUser

Gets details of a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getUser(GetUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getUser(UserName name) + *
  • getUser(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getUserCallable() + *
+ *
CreateUser

Creates a new User in a given project, location, and cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createUser(CreateUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createUser(ClusterName parent, User user, String userId) + *
  • createUser(String parent, User user, String userId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createUserCallable() + *
+ *
UpdateUser

Updates the parameters of a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateUser(UpdateUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateUser(User user, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateUserCallable() + *
+ *
DeleteUser

Deletes a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteUser(DeleteUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteUser(UserName name) + *
  • deleteUser(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteUserCallable() + *
+ *
ListDatabases

Lists Databases in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDatabases(ListDatabasesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDatabases(ClusterName parent) + *
  • listDatabases(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDatabasesPagedCallable() + *
  • listDatabasesCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/stub/AlloyDBAdminStubSettings.java b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/stub/AlloyDBAdminStubSettings.java index f6fd3e8c2d78..85db229d3bb0 100644 --- a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/stub/AlloyDBAdminStubSettings.java +++ b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1alpha/stub/AlloyDBAdminStubSettings.java @@ -947,6 +947,12 @@ public AlloyDBAdminStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "alloydb"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/AlloyDBAdminClient.java b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/AlloyDBAdminClient.java index 22a3c2d566a9..585681116a40 100644 --- a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/AlloyDBAdminClient.java +++ b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/AlloyDBAdminClient.java @@ -65,19 +65,639 @@ *

Note: close() needs to be called on the AlloyDBAdminClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListClusters

Lists Clusters in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listClusters(ListClustersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listClusters(LocationName parent) + *
  • listClusters(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listClustersPagedCallable() + *
  • listClustersCallable() + *
+ *
GetCluster

Gets details of a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCluster(GetClusterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCluster(ClusterName name) + *
  • getCluster(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getClusterCallable() + *
+ *
CreateCluster

Creates a new Cluster in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createClusterAsync(CreateClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createClusterAsync(LocationName parent, Cluster cluster, String clusterId) + *
  • createClusterAsync(String parent, Cluster cluster, String clusterId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createClusterOperationCallable() + *
  • createClusterCallable() + *
+ *
UpdateCluster

Updates the parameters of a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateClusterAsync(UpdateClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateClusterAsync(Cluster cluster, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateClusterOperationCallable() + *
  • updateClusterCallable() + *
+ *
DeleteCluster

Deletes a single Cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteClusterAsync(DeleteClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteClusterAsync(ClusterName name) + *
  • deleteClusterAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteClusterOperationCallable() + *
  • deleteClusterCallable() + *
+ *
PromoteCluster

Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • promoteClusterAsync(PromoteClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • promoteClusterAsync(ClusterName name) + *
  • promoteClusterAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • promoteClusterOperationCallable() + *
  • promoteClusterCallable() + *
+ *
RestoreCluster

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restoreClusterAsync(RestoreClusterRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restoreClusterOperationCallable() + *
  • restoreClusterCallable() + *
+ *
CreateSecondaryCluster

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSecondaryClusterAsync(CreateSecondaryClusterRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSecondaryClusterAsync(LocationName parent, Cluster cluster, String clusterId) + *
  • createSecondaryClusterAsync(String parent, Cluster cluster, String clusterId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSecondaryClusterOperationCallable() + *
  • createSecondaryClusterCallable() + *
+ *
ListInstances

Lists Instances in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listInstances(ListInstancesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listInstances(ClusterName parent) + *
  • listInstances(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listInstancesPagedCallable() + *
  • listInstancesCallable() + *
+ *
GetInstance

Gets details of a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getInstance(GetInstanceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getInstance(InstanceName name) + *
  • getInstance(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getInstanceCallable() + *
+ *
CreateInstance

Creates a new Instance in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createInstanceAsync(CreateInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createInstanceAsync(ClusterName parent, Instance instance, String instanceId) + *
  • createInstanceAsync(String parent, Instance instance, String instanceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createInstanceOperationCallable() + *
  • createInstanceCallable() + *
+ *
CreateSecondaryInstance

Creates a new SECONDARY Instance in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSecondaryInstanceAsync(CreateSecondaryInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createSecondaryInstanceAsync(ClusterName parent, Instance instance, String instanceId) + *
  • createSecondaryInstanceAsync(String parent, Instance instance, String instanceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSecondaryInstanceOperationCallable() + *
  • createSecondaryInstanceCallable() + *
+ *
BatchCreateInstances

Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateInstancesAsync(BatchCreateInstancesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateInstancesOperationCallable() + *
  • batchCreateInstancesCallable() + *
+ *
UpdateInstance

Updates the parameters of a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateInstanceAsync(UpdateInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateInstanceAsync(Instance instance, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateInstanceOperationCallable() + *
  • updateInstanceCallable() + *
+ *
DeleteInstance

Deletes a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteInstanceAsync(DeleteInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteInstanceAsync(InstanceName name) + *
  • deleteInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteInstanceOperationCallable() + *
  • deleteInstanceCallable() + *
+ *
FailoverInstance

Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • failoverInstanceAsync(FailoverInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • failoverInstanceAsync(InstanceName name) + *
  • failoverInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • failoverInstanceOperationCallable() + *
  • failoverInstanceCallable() + *
+ *
InjectFault

Injects fault in an instance. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • injectFaultAsync(InjectFaultRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • injectFaultAsync(InjectFaultRequest.FaultType faultType, InstanceName name) + *
  • injectFaultAsync(InjectFaultRequest.FaultType faultType, String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • injectFaultOperationCallable() + *
  • injectFaultCallable() + *
+ *
RestartInstance

Restart an Instance in a cluster. Imperative only.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restartInstanceAsync(RestartInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • restartInstanceAsync(InstanceName name) + *
  • restartInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restartInstanceOperationCallable() + *
  • restartInstanceCallable() + *
+ *
ListBackups

Lists Backups in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listBackups(ListBackupsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listBackups(LocationName parent) + *
  • listBackups(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listBackupsPagedCallable() + *
  • listBackupsCallable() + *
+ *
GetBackup

Gets details of a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getBackup(GetBackupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getBackup(BackupName name) + *
  • getBackup(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getBackupCallable() + *
+ *
CreateBackup

Creates a new Backup in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createBackupAsync(CreateBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createBackupAsync(LocationName parent, Backup backup, String backupId) + *
  • createBackupAsync(String parent, Backup backup, String backupId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createBackupOperationCallable() + *
  • createBackupCallable() + *
+ *
UpdateBackup

Updates the parameters of a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateBackupAsync(UpdateBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateBackupAsync(Backup backup, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateBackupOperationCallable() + *
  • updateBackupCallable() + *
+ *
DeleteBackup

Deletes a single Backup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteBackupAsync(DeleteBackupRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteBackupAsync(BackupName name) + *
  • deleteBackupAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteBackupOperationCallable() + *
  • deleteBackupCallable() + *
+ *
ListSupportedDatabaseFlags

Lists SupportedDatabaseFlags for a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSupportedDatabaseFlags(LocationName parent) + *
  • listSupportedDatabaseFlags(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSupportedDatabaseFlagsPagedCallable() + *
  • listSupportedDatabaseFlagsCallable() + *
+ *
GenerateClientCertificate

Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • generateClientCertificate(GenerateClientCertificateRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • generateClientCertificate(ClusterName parent) + *
  • generateClientCertificate(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • generateClientCertificateCallable() + *
+ *
GetConnectionInfo

Get instance metadata used for a connection.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getConnectionInfo(GetConnectionInfoRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getConnectionInfo(InstanceName parent) + *
  • getConnectionInfo(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getConnectionInfoCallable() + *
+ *
ListUsers

Lists Users in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listUsers(ListUsersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listUsers(ClusterName parent) + *
  • listUsers(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listUsersPagedCallable() + *
  • listUsersCallable() + *
+ *
GetUser

Gets details of a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getUser(GetUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getUser(UserName name) + *
  • getUser(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getUserCallable() + *
+ *
CreateUser

Creates a new User in a given project, location, and cluster.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createUser(CreateUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createUser(ClusterName parent, User user, String userId) + *
  • createUser(String parent, User user, String userId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createUserCallable() + *
+ *
UpdateUser

Updates the parameters of a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateUser(UpdateUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateUser(User user, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateUserCallable() + *
+ *
DeleteUser

Deletes a single User.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteUser(DeleteUserRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteUser(UserName name) + *
  • deleteUser(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteUserCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/stub/AlloyDBAdminStubSettings.java b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/stub/AlloyDBAdminStubSettings.java index 99a333462995..b93cecc06490 100644 --- a/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/stub/AlloyDBAdminStubSettings.java +++ b/java-alloydb/google-cloud-alloydb/src/main/java/com/google/cloud/alloydb/v1beta/stub/AlloyDBAdminStubSettings.java @@ -881,6 +881,12 @@ public AlloyDBAdminStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "alloydb"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/AnalyticsAdminServiceClient.java b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/AnalyticsAdminServiceClient.java index 291839355ee4..d1d0937e0ae1 100644 --- a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/AnalyticsAdminServiceClient.java +++ b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/AnalyticsAdminServiceClient.java @@ -59,19 +59,2409 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
GetAccount

Lookup for a single Account.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAccount(GetAccountRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAccount(AccountName name) + *
  • getAccount(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAccountCallable() + *
+ *
ListAccounts

Returns all accounts accessible by the caller. + *

Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAccounts(ListAccountsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAccountsPagedCallable() + *
  • listAccountsCallable() + *
+ *
DeleteAccount

Marks target Account as soft-deleted (ie: "trashed") and returns it. + *

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. + *

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 + *

Returns an error if the target is not found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAccount(DeleteAccountRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteAccount(AccountName name) + *
  • deleteAccount(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAccountCallable() + *
+ *
UpdateAccount

Updates an account.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAccount(UpdateAccountRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateAccount(Account account, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAccountCallable() + *
+ *
ProvisionAccountTicket

Requests a ticket for creating an account.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • provisionAccountTicket(ProvisionAccountTicketRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • provisionAccountTicketCallable() + *
+ *
ListAccountSummaries

Returns summaries of all accounts accessible by the caller.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAccountSummaries(ListAccountSummariesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAccountSummariesPagedCallable() + *
  • listAccountSummariesCallable() + *
+ *
GetProperty

Lookup for a single "GA4" Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getProperty(GetPropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getProperty(PropertyName name) + *
  • getProperty(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPropertyCallable() + *
+ *
ListProperties

Returns child Properties under the specified parent Account. + *

Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listProperties(ListPropertiesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPropertiesPagedCallable() + *
  • listPropertiesCallable() + *
+ *
CreateProperty

Creates an "GA4" property with the specified location and attributes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createProperty(CreatePropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createProperty(Property property) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createPropertyCallable() + *
+ *
DeleteProperty

Marks target Property as soft-deleted (ie: "trashed") and returns it. + *

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. + *

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 + *

Returns an error if the target is not found, or is not a GA4 Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteProperty(DeletePropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteProperty(PropertyName name) + *
  • deleteProperty(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deletePropertyCallable() + *
+ *
UpdateProperty

Updates a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateProperty(UpdatePropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateProperty(Property property, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updatePropertyCallable() + *
+ *
CreateFirebaseLink

Creates a FirebaseLink. + *

Properties can have at most one FirebaseLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFirebaseLink(CreateFirebaseLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createFirebaseLink(PropertyName parent, FirebaseLink firebaseLink) + *
  • createFirebaseLink(String parent, FirebaseLink firebaseLink) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFirebaseLinkCallable() + *
+ *
DeleteFirebaseLink

Deletes a FirebaseLink on a property

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFirebaseLink(DeleteFirebaseLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteFirebaseLink(FirebaseLinkName name) + *
  • deleteFirebaseLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFirebaseLinkCallable() + *
+ *
ListFirebaseLinks

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFirebaseLinks(ListFirebaseLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFirebaseLinks(PropertyName parent) + *
  • listFirebaseLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFirebaseLinksPagedCallable() + *
  • listFirebaseLinksCallable() + *
+ *
GetGlobalSiteTag

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getGlobalSiteTag(GetGlobalSiteTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getGlobalSiteTag(GlobalSiteTagName name) + *
  • getGlobalSiteTag(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getGlobalSiteTagCallable() + *
+ *
CreateGoogleAdsLink

Creates a GoogleAdsLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createGoogleAdsLink(CreateGoogleAdsLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createGoogleAdsLink(PropertyName parent, GoogleAdsLink googleAdsLink) + *
  • createGoogleAdsLink(String parent, GoogleAdsLink googleAdsLink) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createGoogleAdsLinkCallable() + *
+ *
UpdateGoogleAdsLink

Updates a GoogleAdsLink on a property

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateGoogleAdsLink(GoogleAdsLink googleAdsLink, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateGoogleAdsLinkCallable() + *
+ *
DeleteGoogleAdsLink

Deletes a GoogleAdsLink on a property

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteGoogleAdsLink(GoogleAdsLinkName name) + *
  • deleteGoogleAdsLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteGoogleAdsLinkCallable() + *
+ *
ListGoogleAdsLinks

Lists GoogleAdsLinks on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listGoogleAdsLinks(ListGoogleAdsLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listGoogleAdsLinks(PropertyName parent) + *
  • listGoogleAdsLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listGoogleAdsLinksPagedCallable() + *
  • listGoogleAdsLinksCallable() + *
+ *
GetDataSharingSettings

Get data sharing settings on an account. Data sharing settings are singletons.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataSharingSettings(GetDataSharingSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataSharingSettings(DataSharingSettingsName name) + *
  • getDataSharingSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataSharingSettingsCallable() + *
+ *
GetMeasurementProtocolSecret

Lookup for a single "GA4" MeasurementProtocolSecret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMeasurementProtocolSecret(MeasurementProtocolSecretName name) + *
  • getMeasurementProtocolSecret(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMeasurementProtocolSecretCallable() + *
+ *
ListMeasurementProtocolSecrets

Returns child MeasurementProtocolSecrets under the specified parent Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listMeasurementProtocolSecrets(DataStreamName parent) + *
  • listMeasurementProtocolSecrets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listMeasurementProtocolSecretsPagedCallable() + *
  • listMeasurementProtocolSecretsCallable() + *
+ *
CreateMeasurementProtocolSecret

Creates a measurement protocol secret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret) + *
  • createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createMeasurementProtocolSecretCallable() + *
+ *
DeleteMeasurementProtocolSecret

Deletes target MeasurementProtocolSecret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name) + *
  • deleteMeasurementProtocolSecret(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteMeasurementProtocolSecretCallable() + *
+ *
UpdateMeasurementProtocolSecret

Updates a measurement protocol secret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateMeasurementProtocolSecretCallable() + *
+ *
AcknowledgeUserDataCollection

Acknowledges the terms of user data collection for the specified property. + *

This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • acknowledgeUserDataCollectionCallable() + *
+ *
GetSKAdNetworkConversionValueSchema

Looks up a single SKAdNetworkConversionValueSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name) + *
  • getSKAdNetworkConversionValueSchema(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSKAdNetworkConversionValueSchemaCallable() + *
+ *
CreateSKAdNetworkConversionValueSchema

Creates a SKAdNetworkConversionValueSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createSKAdNetworkConversionValueSchema(DataStreamName parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema) + *
  • createSKAdNetworkConversionValueSchema(String parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSKAdNetworkConversionValueSchemaCallable() + *
+ *
DeleteSKAdNetworkConversionValueSchema

Deletes target SKAdNetworkConversionValueSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name) + *
  • deleteSKAdNetworkConversionValueSchema(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSKAdNetworkConversionValueSchemaCallable() + *
+ *
UpdateSKAdNetworkConversionValueSchema

Updates a SKAdNetworkConversionValueSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateSKAdNetworkConversionValueSchemaCallable() + *
+ *
ListSKAdNetworkConversionValueSchemas

Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSKAdNetworkConversionValueSchemas(DataStreamName parent) + *
  • listSKAdNetworkConversionValueSchemas(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSKAdNetworkConversionValueSchemasPagedCallable() + *
  • listSKAdNetworkConversionValueSchemasCallable() + *
+ *
SearchChangeHistoryEvents

Searches through all changes to an account or its children given the specified set of filters.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchChangeHistoryEventsPagedCallable() + *
  • searchChangeHistoryEventsCallable() + *
+ *
GetGoogleSignalsSettings

Lookup for Google Signals settings for a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getGoogleSignalsSettings(GoogleSignalsSettingsName name) + *
  • getGoogleSignalsSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getGoogleSignalsSettingsCallable() + *
+ *
UpdateGoogleSignalsSettings

Updates Google Signals settings for a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateGoogleSignalsSettings(GoogleSignalsSettings googleSignalsSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateGoogleSignalsSettingsCallable() + *
+ *
CreateConversionEvent

Creates a conversion event with the specified attributes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createConversionEvent(CreateConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createConversionEvent(PropertyName parent, ConversionEvent conversionEvent) + *
  • createConversionEvent(String parent, ConversionEvent conversionEvent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createConversionEventCallable() + *
+ *
UpdateConversionEvent

Updates a conversion event with the specified attributes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateConversionEvent(UpdateConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateConversionEvent(ConversionEvent conversionEvent, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateConversionEventCallable() + *
+ *
GetConversionEvent

Retrieve a single conversion event.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getConversionEvent(GetConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getConversionEvent(ConversionEventName name) + *
  • getConversionEvent(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getConversionEventCallable() + *
+ *
DeleteConversionEvent

Deletes a conversion event in a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteConversionEvent(DeleteConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteConversionEvent(ConversionEventName name) + *
  • deleteConversionEvent(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteConversionEventCallable() + *
+ *
ListConversionEvents

Returns a list of conversion events in the specified parent property. + *

Returns an empty list if no conversion events are found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listConversionEvents(ListConversionEventsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listConversionEvents(PropertyName parent) + *
  • listConversionEvents(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listConversionEventsPagedCallable() + *
  • listConversionEventsCallable() + *
+ *
GetDisplayVideo360AdvertiserLink

Look up a single DisplayVideo360AdvertiserLink

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name) + *
  • getDisplayVideo360AdvertiserLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDisplayVideo360AdvertiserLinkCallable() + *
+ *
ListDisplayVideo360AdvertiserLinks

Lists all DisplayVideo360AdvertiserLinks on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDisplayVideo360AdvertiserLinks(PropertyName parent) + *
  • listDisplayVideo360AdvertiserLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDisplayVideo360AdvertiserLinksPagedCallable() + *
  • listDisplayVideo360AdvertiserLinksCallable() + *
+ *
CreateDisplayVideo360AdvertiserLink

Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDisplayVideo360AdvertiserLink(PropertyName parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink) + *
  • createDisplayVideo360AdvertiserLink(String parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDisplayVideo360AdvertiserLinkCallable() + *
+ *
DeleteDisplayVideo360AdvertiserLink

Deletes a DisplayVideo360AdvertiserLink on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name) + *
  • deleteDisplayVideo360AdvertiserLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDisplayVideo360AdvertiserLinkCallable() + *
+ *
UpdateDisplayVideo360AdvertiserLink

Updates a DisplayVideo360AdvertiserLink on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDisplayVideo360AdvertiserLinkCallable() + *
+ *
GetDisplayVideo360AdvertiserLinkProposal

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name) + *
  • getDisplayVideo360AdvertiserLinkProposal(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDisplayVideo360AdvertiserLinkProposalCallable() + *
+ *
ListDisplayVideo360AdvertiserLinkProposals

Lists DisplayVideo360AdvertiserLinkProposals on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDisplayVideo360AdvertiserLinkProposals(PropertyName parent) + *
  • listDisplayVideo360AdvertiserLinkProposals(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDisplayVideo360AdvertiserLinkProposalsPagedCallable() + *
  • listDisplayVideo360AdvertiserLinkProposalsCallable() + *
+ *
CreateDisplayVideo360AdvertiserLinkProposal

Creates a DisplayVideo360AdvertiserLinkProposal.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDisplayVideo360AdvertiserLinkProposal(PropertyName parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal) + *
  • createDisplayVideo360AdvertiserLinkProposal(String parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDisplayVideo360AdvertiserLinkProposalCallable() + *
+ *
DeleteDisplayVideo360AdvertiserLinkProposal

Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name) + *
  • deleteDisplayVideo360AdvertiserLinkProposal(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDisplayVideo360AdvertiserLinkProposalCallable() + *
+ *
ApproveDisplayVideo360AdvertiserLinkProposal

Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • approveDisplayVideo360AdvertiserLinkProposalCallable() + *
+ *
CancelDisplayVideo360AdvertiserLinkProposal

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • cancelDisplayVideo360AdvertiserLinkProposalCallable() + *
+ *
CreateCustomDimension

Creates a CustomDimension.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createCustomDimension(CreateCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createCustomDimension(PropertyName parent, CustomDimension customDimension) + *
  • createCustomDimension(String parent, CustomDimension customDimension) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createCustomDimensionCallable() + *
+ *
UpdateCustomDimension

Updates a CustomDimension on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateCustomDimension(UpdateCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateCustomDimension(CustomDimension customDimension, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateCustomDimensionCallable() + *
+ *
ListCustomDimensions

Lists CustomDimensions on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listCustomDimensions(ListCustomDimensionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listCustomDimensions(PropertyName parent) + *
  • listCustomDimensions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listCustomDimensionsPagedCallable() + *
  • listCustomDimensionsCallable() + *
+ *
ArchiveCustomDimension

Archives a CustomDimension on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • archiveCustomDimension(ArchiveCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • archiveCustomDimension(CustomDimensionName name) + *
  • archiveCustomDimension(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • archiveCustomDimensionCallable() + *
+ *
GetCustomDimension

Lookup for a single CustomDimension.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCustomDimension(GetCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCustomDimension(CustomDimensionName name) + *
  • getCustomDimension(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getCustomDimensionCallable() + *
+ *
CreateCustomMetric

Creates a CustomMetric.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createCustomMetric(CreateCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createCustomMetric(PropertyName parent, CustomMetric customMetric) + *
  • createCustomMetric(String parent, CustomMetric customMetric) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createCustomMetricCallable() + *
+ *
UpdateCustomMetric

Updates a CustomMetric on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateCustomMetric(UpdateCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateCustomMetric(CustomMetric customMetric, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateCustomMetricCallable() + *
+ *
ListCustomMetrics

Lists CustomMetrics on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listCustomMetrics(ListCustomMetricsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listCustomMetrics(PropertyName parent) + *
  • listCustomMetrics(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listCustomMetricsPagedCallable() + *
  • listCustomMetricsCallable() + *
+ *
ArchiveCustomMetric

Archives a CustomMetric on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • archiveCustomMetric(ArchiveCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • archiveCustomMetric(CustomMetricName name) + *
  • archiveCustomMetric(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • archiveCustomMetricCallable() + *
+ *
GetCustomMetric

Lookup for a single CustomMetric.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCustomMetric(GetCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCustomMetric(CustomMetricName name) + *
  • getCustomMetric(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getCustomMetricCallable() + *
+ *
GetDataRetentionSettings

Returns the singleton data retention settings for this property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataRetentionSettings(GetDataRetentionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataRetentionSettings(DataRetentionSettingsName name) + *
  • getDataRetentionSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataRetentionSettingsCallable() + *
+ *
UpdateDataRetentionSettings

Updates the singleton data retention settings for this property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDataRetentionSettingsCallable() + *
+ *
CreateDataStream

Creates a DataStream.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDataStream(CreateDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDataStream(PropertyName parent, DataStream dataStream) + *
  • createDataStream(String parent, DataStream dataStream) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDataStreamCallable() + *
+ *
DeleteDataStream

Deletes a DataStream on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDataStream(DeleteDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteDataStream(DataStreamName name) + *
  • deleteDataStream(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDataStreamCallable() + *
+ *
UpdateDataStream

Updates a DataStream on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataStream(UpdateDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataStream(DataStream dataStream, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDataStreamCallable() + *
+ *
ListDataStreams

Lists DataStreams on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDataStreams(ListDataStreamsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDataStreams(PropertyName parent) + *
  • listDataStreams(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDataStreamsPagedCallable() + *
  • listDataStreamsCallable() + *
+ *
GetDataStream

Lookup for a single DataStream.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataStream(GetDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataStream(DataStreamName name) + *
  • getDataStream(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataStreamCallable() + *
+ *
GetAudience

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAudience(GetAudienceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAudience(AudienceName name) + *
  • getAudience(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAudienceCallable() + *
+ *
ListAudiences

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAudiences(ListAudiencesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAudiences(PropertyName parent) + *
  • listAudiences(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAudiencesPagedCallable() + *
  • listAudiencesCallable() + *
+ *
CreateAudience

Creates an Audience.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAudience(CreateAudienceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createAudience(PropertyName parent, Audience audience) + *
  • createAudience(String parent, Audience audience) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAudienceCallable() + *
+ *
UpdateAudience

Updates an Audience on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAudience(UpdateAudienceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateAudience(Audience audience, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAudienceCallable() + *
+ *
ArchiveAudience

Archives an Audience on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • archiveAudience(ArchiveAudienceRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • archiveAudienceCallable() + *
+ *
GetSearchAds360Link

Look up a single SearchAds360Link

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSearchAds360Link(GetSearchAds360LinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSearchAds360Link(SearchAds360LinkName name) + *
  • getSearchAds360Link(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSearchAds360LinkCallable() + *
+ *
ListSearchAds360Links

Lists all SearchAds360Links on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSearchAds360Links(ListSearchAds360LinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSearchAds360Links(PropertyName parent) + *
  • listSearchAds360Links(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSearchAds360LinksPagedCallable() + *
  • listSearchAds360LinksCallable() + *
+ *
CreateSearchAds360Link

Creates a SearchAds360Link.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSearchAds360Link(CreateSearchAds360LinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createSearchAds360Link(PropertyName parent, SearchAds360Link searchAds360Link) + *
  • createSearchAds360Link(String parent, SearchAds360Link searchAds360Link) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSearchAds360LinkCallable() + *
+ *
DeleteSearchAds360Link

Deletes a SearchAds360Link on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSearchAds360Link(DeleteSearchAds360LinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteSearchAds360Link(SearchAds360LinkName name) + *
  • deleteSearchAds360Link(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSearchAds360LinkCallable() + *
+ *
UpdateSearchAds360Link

Updates a SearchAds360Link on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSearchAds360Link(UpdateSearchAds360LinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateSearchAds360Link(SearchAds360Link searchAds360Link, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateSearchAds360LinkCallable() + *
+ *
GetAttributionSettings

Lookup for a AttributionSettings singleton.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAttributionSettings(GetAttributionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAttributionSettings(AttributionSettingsName name) + *
  • getAttributionSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAttributionSettingsCallable() + *
+ *
UpdateAttributionSettings

Updates attribution settings on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAttributionSettings(UpdateAttributionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateAttributionSettings(AttributionSettings attributionSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAttributionSettingsCallable() + *
+ *
RunAccessReport

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. + *

Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. + *

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • runAccessReport(RunAccessReportRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • runAccessReportCallable() + *
+ *
CreateAccessBinding

Creates an access binding on an account or property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAccessBinding(CreateAccessBindingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createAccessBinding(AccountName parent, AccessBinding accessBinding) + *
  • createAccessBinding(PropertyName parent, AccessBinding accessBinding) + *
  • createAccessBinding(String parent, AccessBinding accessBinding) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAccessBindingCallable() + *
+ *
GetAccessBinding

Gets information about an access binding.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAccessBinding(GetAccessBindingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAccessBinding(AccessBindingName name) + *
  • getAccessBinding(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAccessBindingCallable() + *
+ *
UpdateAccessBinding

Updates an access binding on an account or property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAccessBinding(UpdateAccessBindingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateAccessBinding(AccessBinding accessBinding) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAccessBindingCallable() + *
+ *
DeleteAccessBinding

Deletes an access binding on an account or property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAccessBinding(DeleteAccessBindingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteAccessBinding(AccessBindingName name) + *
  • deleteAccessBinding(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAccessBindingCallable() + *
+ *
ListAccessBindings

Lists all access bindings on an account or property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAccessBindings(ListAccessBindingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAccessBindings(AccountName parent) + *
  • listAccessBindings(PropertyName parent) + *
  • listAccessBindings(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAccessBindingsPagedCallable() + *
  • listAccessBindingsCallable() + *
+ *
BatchCreateAccessBindings

Creates information about multiple access bindings to an account or property. + *

This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateAccessBindings(BatchCreateAccessBindingsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateAccessBindingsCallable() + *
+ *
BatchGetAccessBindings

Gets information about multiple access bindings to an account or property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchGetAccessBindings(BatchGetAccessBindingsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchGetAccessBindingsCallable() + *
+ *
BatchUpdateAccessBindings

Updates information about multiple access bindings to an account or property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchUpdateAccessBindingsCallable() + *
+ *
BatchDeleteAccessBindings

Deletes information about multiple users' links to an account or property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchDeleteAccessBindingsCallable() + *
+ *
GetExpandedDataSet

Lookup for a single ExpandedDataSet.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getExpandedDataSet(GetExpandedDataSetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getExpandedDataSet(ExpandedDataSetName name) + *
  • getExpandedDataSet(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getExpandedDataSetCallable() + *
+ *
ListExpandedDataSets

Lists ExpandedDataSets on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listExpandedDataSets(ListExpandedDataSetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listExpandedDataSets(PropertyName parent) + *
  • listExpandedDataSets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listExpandedDataSetsPagedCallable() + *
  • listExpandedDataSetsCallable() + *
+ *
CreateExpandedDataSet

Creates a ExpandedDataSet.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createExpandedDataSet(CreateExpandedDataSetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createExpandedDataSet(PropertyName parent, ExpandedDataSet expandedDataSet) + *
  • createExpandedDataSet(String parent, ExpandedDataSet expandedDataSet) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createExpandedDataSetCallable() + *
+ *
UpdateExpandedDataSet

Updates a ExpandedDataSet on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateExpandedDataSet(UpdateExpandedDataSetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateExpandedDataSet(ExpandedDataSet expandedDataSet, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateExpandedDataSetCallable() + *
+ *
DeleteExpandedDataSet

Deletes a ExpandedDataSet on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteExpandedDataSet(DeleteExpandedDataSetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteExpandedDataSet(ExpandedDataSetName name) + *
  • deleteExpandedDataSet(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteExpandedDataSetCallable() + *
+ *
GetChannelGroup

Lookup for a single ChannelGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getChannelGroup(GetChannelGroupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getChannelGroup(ChannelGroupName name) + *
  • getChannelGroup(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getChannelGroupCallable() + *
+ *
ListChannelGroups

Lists ChannelGroups on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listChannelGroups(ListChannelGroupsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listChannelGroups(PropertyName parent) + *
  • listChannelGroups(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listChannelGroupsPagedCallable() + *
  • listChannelGroupsCallable() + *
+ *
CreateChannelGroup

Creates a ChannelGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createChannelGroup(CreateChannelGroupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createChannelGroup(PropertyName parent, ChannelGroup channelGroup) + *
  • createChannelGroup(String parent, ChannelGroup channelGroup) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createChannelGroupCallable() + *
+ *
UpdateChannelGroup

Updates a ChannelGroup.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateChannelGroup(UpdateChannelGroupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateChannelGroup(ChannelGroup channelGroup, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateChannelGroupCallable() + *
+ *
DeleteChannelGroup

Deletes a ChannelGroup on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteChannelGroup(DeleteChannelGroupRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteChannelGroup(ChannelGroupName name) + *
  • deleteChannelGroup(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteChannelGroupCallable() + *
+ *
SetAutomatedGa4ConfigurationOptOut

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setAutomatedGa4ConfigurationOptOutCallable() + *
+ *
FetchAutomatedGa4ConfigurationOptOut

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • fetchAutomatedGa4ConfigurationOptOutCallable() + *
+ *
GetBigQueryLink

Lookup for a single BigQuery Link.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getBigQueryLink(GetBigQueryLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getBigQueryLink(BigQueryLinkName name) + *
  • getBigQueryLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getBigQueryLinkCallable() + *
+ *
ListBigQueryLinks

Lists BigQuery Links on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listBigQueryLinks(ListBigQueryLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listBigQueryLinks(PropertyName parent) + *
  • listBigQueryLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listBigQueryLinksPagedCallable() + *
  • listBigQueryLinksCallable() + *
+ *
GetEnhancedMeasurementSettings

Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getEnhancedMeasurementSettings(EnhancedMeasurementSettingsName name) + *
  • getEnhancedMeasurementSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getEnhancedMeasurementSettingsCallable() + *
+ *
UpdateEnhancedMeasurementSettings

Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateEnhancedMeasurementSettings(EnhancedMeasurementSettings enhancedMeasurementSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateEnhancedMeasurementSettingsCallable() + *
+ *
CreateConnectedSiteTag

Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createConnectedSiteTag(CreateConnectedSiteTagRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createConnectedSiteTagCallable() + *
+ *
DeleteConnectedSiteTag

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteConnectedSiteTagCallable() + *
+ *
ListConnectedSiteTags

Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listConnectedSiteTags(ListConnectedSiteTagsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listConnectedSiteTagsCallable() + *
+ *
FetchConnectedGa4Property

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • fetchConnectedGa4PropertyCallable() + *
+ *
GetAdSenseLink

Looks up a single AdSenseLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAdSenseLink(GetAdSenseLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAdSenseLink(AdSenseLinkName name) + *
  • getAdSenseLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAdSenseLinkCallable() + *
+ *
CreateAdSenseLink

Creates an AdSenseLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAdSenseLink(CreateAdSenseLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createAdSenseLink(PropertyName parent, AdSenseLink adsenseLink) + *
  • createAdSenseLink(String parent, AdSenseLink adsenseLink) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAdSenseLinkCallable() + *
+ *
DeleteAdSenseLink

Deletes an AdSenseLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAdSenseLink(DeleteAdSenseLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteAdSenseLink(AdSenseLinkName name) + *
  • deleteAdSenseLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAdSenseLinkCallable() + *
+ *
ListAdSenseLinks

Lists AdSenseLinks on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAdSenseLinks(ListAdSenseLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAdSenseLinks(PropertyName parent) + *
  • listAdSenseLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAdSenseLinksPagedCallable() + *
  • listAdSenseLinksCallable() + *
+ *
GetEventCreateRule

Lookup for a single EventCreateRule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getEventCreateRule(GetEventCreateRuleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getEventCreateRule(EventCreateRuleName name) + *
  • getEventCreateRule(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getEventCreateRuleCallable() + *
+ *
ListEventCreateRules

Lists EventCreateRules on a web data stream.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listEventCreateRules(ListEventCreateRulesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listEventCreateRules(DataStreamName parent) + *
  • listEventCreateRules(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listEventCreateRulesPagedCallable() + *
  • listEventCreateRulesCallable() + *
+ *
CreateEventCreateRule

Creates an EventCreateRule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createEventCreateRule(CreateEventCreateRuleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createEventCreateRule(DataStreamName parent, EventCreateRule eventCreateRule) + *
  • createEventCreateRule(String parent, EventCreateRule eventCreateRule) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createEventCreateRuleCallable() + *
+ *
UpdateEventCreateRule

Updates an EventCreateRule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateEventCreateRule(UpdateEventCreateRuleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateEventCreateRule(EventCreateRule eventCreateRule, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateEventCreateRuleCallable() + *
+ *
DeleteEventCreateRule

Deletes an EventCreateRule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteEventCreateRule(DeleteEventCreateRuleRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteEventCreateRule(EventCreateRuleName name) + *
  • deleteEventCreateRule(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteEventCreateRuleCallable() + *
+ *
UpdateDataRedactionSettings

Updates a DataRedactionSettings on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataRedactionSettings(DataRedactionSettings dataRedactionSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDataRedactionSettingsCallable() + *
+ *
GetDataRedactionSettings

Lookup for a single DataRedactionSettings.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataRedactionSettings(GetDataRedactionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataRedactionSettings(DataRedactionSettingsName name) + *
  • getDataRedactionSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataRedactionSettingsCallable() + *
+ *
CreateRollupProperty

Create a roll-up property and all roll-up property source links.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createRollupProperty(CreateRollupPropertyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createRollupPropertyCallable() + *
+ *
GetRollupPropertySourceLink

Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getRollupPropertySourceLink(RollupPropertySourceLinkName name) + *
  • getRollupPropertySourceLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getRollupPropertySourceLinkCallable() + *
+ *
ListRollupPropertySourceLinks

Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listRollupPropertySourceLinks(PropertyName parent) + *
  • listRollupPropertySourceLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listRollupPropertySourceLinksPagedCallable() + *
  • listRollupPropertySourceLinksCallable() + *
+ *
CreateRollupPropertySourceLink

Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createRollupPropertySourceLink(PropertyName parent, RollupPropertySourceLink rollupPropertySourceLink) + *
  • createRollupPropertySourceLink(String parent, RollupPropertySourceLink rollupPropertySourceLink) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createRollupPropertySourceLinkCallable() + *
+ *
DeleteRollupPropertySourceLink

Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteRollupPropertySourceLink(RollupPropertySourceLinkName name) + *
  • deleteRollupPropertySourceLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteRollupPropertySourceLinkCallable() + *
+ *
CreateSubproperty

Create a subproperty and a subproperty event filter that applies to the created subproperty.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSubproperty(CreateSubpropertyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSubpropertyCallable() + *
+ *
CreateSubpropertyEventFilter

Creates a subproperty Event Filter.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createSubpropertyEventFilter(PropertyName parent, SubpropertyEventFilter subpropertyEventFilter) + *
  • createSubpropertyEventFilter(String parent, SubpropertyEventFilter subpropertyEventFilter) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSubpropertyEventFilterCallable() + *
+ *
GetSubpropertyEventFilter

Lookup for a single subproperty Event Filter.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSubpropertyEventFilter(SubpropertyEventFilterName name) + *
  • getSubpropertyEventFilter(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSubpropertyEventFilterCallable() + *
+ *
ListSubpropertyEventFilters

List all subproperty Event Filters on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSubpropertyEventFilters(PropertyName parent) + *
  • listSubpropertyEventFilters(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSubpropertyEventFiltersPagedCallable() + *
  • listSubpropertyEventFiltersCallable() + *
+ *
UpdateSubpropertyEventFilter

Updates a subproperty Event Filter.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateSubpropertyEventFilter(SubpropertyEventFilter subpropertyEventFilter, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateSubpropertyEventFilterCallable() + *
+ *
DeleteSubpropertyEventFilter

Deletes a subproperty event filter.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteSubpropertyEventFilter(SubpropertyEventFilterName name) + *
  • deleteSubpropertyEventFilter(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSubpropertyEventFilterCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/stub/AnalyticsAdminServiceStubSettings.java b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/stub/AnalyticsAdminServiceStubSettings.java index 37aea3347041..9cb68c5a73bd 100644 --- a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/stub/AnalyticsAdminServiceStubSettings.java +++ b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/stub/AnalyticsAdminServiceStubSettings.java @@ -3080,6 +3080,12 @@ public AnalyticsAdminServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "analyticsadmin"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/AnalyticsAdminServiceClient.java b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/AnalyticsAdminServiceClient.java index fa3fad1ce833..a851681dff7f 100644 --- a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/AnalyticsAdminServiceClient.java +++ b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/AnalyticsAdminServiceClient.java @@ -59,19 +59,923 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
GetAccount

Lookup for a single Account.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAccount(GetAccountRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAccount(AccountName name) + *
  • getAccount(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAccountCallable() + *
+ *
ListAccounts

Returns all accounts accessible by the caller. + *

Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAccounts(ListAccountsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAccountsPagedCallable() + *
  • listAccountsCallable() + *
+ *
DeleteAccount

Marks target Account as soft-deleted (ie: "trashed") and returns it. + *

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. + *

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 + *

Returns an error if the target is not found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAccount(DeleteAccountRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteAccount(AccountName name) + *
  • deleteAccount(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAccountCallable() + *
+ *
UpdateAccount

Updates an account.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAccount(UpdateAccountRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateAccount(Account account, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAccountCallable() + *
+ *
ProvisionAccountTicket

Requests a ticket for creating an account.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • provisionAccountTicket(ProvisionAccountTicketRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • provisionAccountTicketCallable() + *
+ *
ListAccountSummaries

Returns summaries of all accounts accessible by the caller.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAccountSummaries(ListAccountSummariesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAccountSummariesPagedCallable() + *
  • listAccountSummariesCallable() + *
+ *
GetProperty

Lookup for a single "GA4" Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getProperty(GetPropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getProperty(PropertyName name) + *
  • getProperty(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPropertyCallable() + *
+ *
ListProperties

Returns child Properties under the specified parent Account. + *

Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listProperties(ListPropertiesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPropertiesPagedCallable() + *
  • listPropertiesCallable() + *
+ *
CreateProperty

Creates an "GA4" property with the specified location and attributes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createProperty(CreatePropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createProperty(Property property) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createPropertyCallable() + *
+ *
DeleteProperty

Marks target Property as soft-deleted (ie: "trashed") and returns it. + *

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. + *

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 + *

Returns an error if the target is not found, or is not a GA4 Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteProperty(DeletePropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteProperty(PropertyName name) + *
  • deleteProperty(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deletePropertyCallable() + *
+ *
UpdateProperty

Updates a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateProperty(UpdatePropertyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateProperty(Property property, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updatePropertyCallable() + *
+ *
CreateFirebaseLink

Creates a FirebaseLink. + *

Properties can have at most one FirebaseLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFirebaseLink(CreateFirebaseLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createFirebaseLink(PropertyName parent, FirebaseLink firebaseLink) + *
  • createFirebaseLink(String parent, FirebaseLink firebaseLink) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFirebaseLinkCallable() + *
+ *
DeleteFirebaseLink

Deletes a FirebaseLink on a property

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFirebaseLink(DeleteFirebaseLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteFirebaseLink(FirebaseLinkName name) + *
  • deleteFirebaseLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFirebaseLinkCallable() + *
+ *
ListFirebaseLinks

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFirebaseLinks(ListFirebaseLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFirebaseLinks(PropertyName parent) + *
  • listFirebaseLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFirebaseLinksPagedCallable() + *
  • listFirebaseLinksCallable() + *
+ *
CreateGoogleAdsLink

Creates a GoogleAdsLink.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createGoogleAdsLink(CreateGoogleAdsLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createGoogleAdsLink(PropertyName parent, GoogleAdsLink googleAdsLink) + *
  • createGoogleAdsLink(String parent, GoogleAdsLink googleAdsLink) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createGoogleAdsLinkCallable() + *
+ *
UpdateGoogleAdsLink

Updates a GoogleAdsLink on a property

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateGoogleAdsLink(GoogleAdsLink googleAdsLink, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateGoogleAdsLinkCallable() + *
+ *
DeleteGoogleAdsLink

Deletes a GoogleAdsLink on a property

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteGoogleAdsLink(GoogleAdsLinkName name) + *
  • deleteGoogleAdsLink(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteGoogleAdsLinkCallable() + *
+ *
ListGoogleAdsLinks

Lists GoogleAdsLinks on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listGoogleAdsLinks(ListGoogleAdsLinksRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listGoogleAdsLinks(PropertyName parent) + *
  • listGoogleAdsLinks(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listGoogleAdsLinksPagedCallable() + *
  • listGoogleAdsLinksCallable() + *
+ *
GetDataSharingSettings

Get data sharing settings on an account. Data sharing settings are singletons.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataSharingSettings(GetDataSharingSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataSharingSettings(DataSharingSettingsName name) + *
  • getDataSharingSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataSharingSettingsCallable() + *
+ *
GetMeasurementProtocolSecret

Lookup for a single "GA4" MeasurementProtocolSecret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMeasurementProtocolSecret(MeasurementProtocolSecretName name) + *
  • getMeasurementProtocolSecret(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMeasurementProtocolSecretCallable() + *
+ *
ListMeasurementProtocolSecrets

Returns child MeasurementProtocolSecrets under the specified parent Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listMeasurementProtocolSecrets(DataStreamName parent) + *
  • listMeasurementProtocolSecrets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listMeasurementProtocolSecretsPagedCallable() + *
  • listMeasurementProtocolSecretsCallable() + *
+ *
CreateMeasurementProtocolSecret

Creates a measurement protocol secret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret) + *
  • createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createMeasurementProtocolSecretCallable() + *
+ *
DeleteMeasurementProtocolSecret

Deletes target MeasurementProtocolSecret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name) + *
  • deleteMeasurementProtocolSecret(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteMeasurementProtocolSecretCallable() + *
+ *
UpdateMeasurementProtocolSecret

Updates a measurement protocol secret.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateMeasurementProtocolSecretCallable() + *
+ *
AcknowledgeUserDataCollection

Acknowledges the terms of user data collection for the specified property. + *

This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • acknowledgeUserDataCollectionCallable() + *
+ *
SearchChangeHistoryEvents

Searches through all changes to an account or its children given the specified set of filters.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchChangeHistoryEventsPagedCallable() + *
  • searchChangeHistoryEventsCallable() + *
+ *
CreateConversionEvent

Creates a conversion event with the specified attributes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createConversionEvent(CreateConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createConversionEvent(PropertyName parent, ConversionEvent conversionEvent) + *
  • createConversionEvent(String parent, ConversionEvent conversionEvent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createConversionEventCallable() + *
+ *
UpdateConversionEvent

Updates a conversion event with the specified attributes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateConversionEvent(UpdateConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateConversionEvent(ConversionEvent conversionEvent, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateConversionEventCallable() + *
+ *
GetConversionEvent

Retrieve a single conversion event.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getConversionEvent(GetConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getConversionEvent(ConversionEventName name) + *
  • getConversionEvent(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getConversionEventCallable() + *
+ *
DeleteConversionEvent

Deletes a conversion event in a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteConversionEvent(DeleteConversionEventRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteConversionEvent(ConversionEventName name) + *
  • deleteConversionEvent(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteConversionEventCallable() + *
+ *
ListConversionEvents

Returns a list of conversion events in the specified parent property. + *

Returns an empty list if no conversion events are found.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listConversionEvents(ListConversionEventsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listConversionEvents(PropertyName parent) + *
  • listConversionEvents(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listConversionEventsPagedCallable() + *
  • listConversionEventsCallable() + *
+ *
CreateCustomDimension

Creates a CustomDimension.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createCustomDimension(CreateCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createCustomDimension(PropertyName parent, CustomDimension customDimension) + *
  • createCustomDimension(String parent, CustomDimension customDimension) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createCustomDimensionCallable() + *
+ *
UpdateCustomDimension

Updates a CustomDimension on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateCustomDimension(UpdateCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateCustomDimension(CustomDimension customDimension, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateCustomDimensionCallable() + *
+ *
ListCustomDimensions

Lists CustomDimensions on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listCustomDimensions(ListCustomDimensionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listCustomDimensions(PropertyName parent) + *
  • listCustomDimensions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listCustomDimensionsPagedCallable() + *
  • listCustomDimensionsCallable() + *
+ *
ArchiveCustomDimension

Archives a CustomDimension on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • archiveCustomDimension(ArchiveCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • archiveCustomDimension(CustomDimensionName name) + *
  • archiveCustomDimension(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • archiveCustomDimensionCallable() + *
+ *
GetCustomDimension

Lookup for a single CustomDimension.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCustomDimension(GetCustomDimensionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCustomDimension(CustomDimensionName name) + *
  • getCustomDimension(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getCustomDimensionCallable() + *
+ *
CreateCustomMetric

Creates a CustomMetric.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createCustomMetric(CreateCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createCustomMetric(PropertyName parent, CustomMetric customMetric) + *
  • createCustomMetric(String parent, CustomMetric customMetric) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createCustomMetricCallable() + *
+ *
UpdateCustomMetric

Updates a CustomMetric on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateCustomMetric(UpdateCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateCustomMetric(CustomMetric customMetric, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateCustomMetricCallable() + *
+ *
ListCustomMetrics

Lists CustomMetrics on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listCustomMetrics(ListCustomMetricsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listCustomMetrics(PropertyName parent) + *
  • listCustomMetrics(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listCustomMetricsPagedCallable() + *
  • listCustomMetricsCallable() + *
+ *
ArchiveCustomMetric

Archives a CustomMetric on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • archiveCustomMetric(ArchiveCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • archiveCustomMetric(CustomMetricName name) + *
  • archiveCustomMetric(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • archiveCustomMetricCallable() + *
+ *
GetCustomMetric

Lookup for a single CustomMetric.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getCustomMetric(GetCustomMetricRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getCustomMetric(CustomMetricName name) + *
  • getCustomMetric(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getCustomMetricCallable() + *
+ *
GetDataRetentionSettings

Returns the singleton data retention settings for this property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataRetentionSettings(GetDataRetentionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataRetentionSettings(DataRetentionSettingsName name) + *
  • getDataRetentionSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataRetentionSettingsCallable() + *
+ *
UpdateDataRetentionSettings

Updates the singleton data retention settings for this property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDataRetentionSettingsCallable() + *
+ *
CreateDataStream

Creates a DataStream.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDataStream(CreateDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDataStream(PropertyName parent, DataStream dataStream) + *
  • createDataStream(String parent, DataStream dataStream) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDataStreamCallable() + *
+ *
DeleteDataStream

Deletes a DataStream on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDataStream(DeleteDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteDataStream(DataStreamName name) + *
  • deleteDataStream(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDataStreamCallable() + *
+ *
UpdateDataStream

Updates a DataStream on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataStream(UpdateDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataStream(DataStream dataStream, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDataStreamCallable() + *
+ *
ListDataStreams

Lists DataStreams on a property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDataStreams(ListDataStreamsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDataStreams(PropertyName parent) + *
  • listDataStreams(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDataStreamsPagedCallable() + *
  • listDataStreamsCallable() + *
+ *
GetDataStream

Lookup for a single DataStream.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataStream(GetDataStreamRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataStream(DataStreamName name) + *
  • getDataStream(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataStreamCallable() + *
+ *
RunAccessReport

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. + *

Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. + *

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • runAccessReport(RunAccessReportRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • runAccessReportCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/stub/AnalyticsAdminServiceStubSettings.java b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/stub/AnalyticsAdminServiceStubSettings.java index f89a6082e792..3b263a1b769e 100644 --- a/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/stub/AnalyticsAdminServiceStubSettings.java +++ b/java-analytics-admin/google-analytics-admin/src/main/java/com/google/analytics/admin/v1beta/stub/AnalyticsAdminServiceStubSettings.java @@ -1302,6 +1302,12 @@ public AnalyticsAdminServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "analyticsadmin"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-analytics-data/README.md b/java-analytics-data/README.md index 336fa2a6f96a..9d028454d521 100644 --- a/java-analytics-data/README.md +++ b/java-analytics-data/README.md @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-preview-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.analytics/google-analytics-data.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.analytics/google-analytics-data/0.42.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.analytics/google-analytics-data/0.43.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataClient.java b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataClient.java index 44d9fe2179eb..f5aba552c9b8 100644 --- a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataClient.java +++ b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataClient.java @@ -71,19 +71,201 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
RunFunnelReport

Returns a customized funnel report of your Google Analytics event data. The data returned from the API is as a table with columns for the requested dimensions and metrics. + *

Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys. To learn more, see [GA4 Funnel Explorations](https://support.google.com/analytics/answer/9327974). + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Data API Funnel Reporting Feedback](https://docs.google.com/forms/d/e/1FAIpQLSdwOlQDJAUoBiIgUZZ3S_Lwi8gr7Bb0k1jhvc-DEg7Rol3UjA/viewform).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • runFunnelReport(RunFunnelReportRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • runFunnelReportCallable() + *
+ *
CreateAudienceList

Creates an audience list for later retrieval. This method quickly returns the audience list's resource name and initiates a long running asynchronous request to form an audience list. To list the users in an audience list, first create the audience list through this method and then send the audience resource name to the `QueryAudienceList` method. + *

See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. + *

An audience list is a snapshot of the users currently in the audience at the time of audience list creation. Creating audience lists for one audience on different days will return different results as users enter and exit the audience. + *

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience lists contain the users in each audience. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAudienceListAsync(CreateAudienceListRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createAudienceListAsync(PropertyName parent, AudienceList audienceList) + *
  • createAudienceListAsync(String parent, AudienceList audienceList) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAudienceListOperationCallable() + *
  • createAudienceListCallable() + *
+ *
QueryAudienceList

Retrieves an audience list of users. After creating an audience, the users are not immediately available for listing. First, a request to `CreateAudienceList` is necessary to create an audience list of users, and then second, this method is used to retrieve the users in the audience list. + *

See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. + *

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryAudienceList(QueryAudienceListRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryAudienceList(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryAudienceListCallable() + *
+ *
SheetExportAudienceList

Exports an audience list of users to a Google Sheet. After creating an audience, the users are not immediately available for listing. First, a request to `CreateAudienceList` is necessary to create an audience list of users, and then second, this method is used to export those users in the audience list to a Google Sheet. + *

See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. + *

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • sheetExportAudienceList(SheetExportAudienceListRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • sheetExportAudienceList(AudienceListName name) + *
  • sheetExportAudienceList(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • sheetExportAudienceListCallable() + *
+ *
GetAudienceList

Gets configuration metadata about a specific audience list. This method can be used to understand an audience list after it has been created. + *

See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAudienceList(GetAudienceListRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAudienceList(AudienceListName name) + *
  • getAudienceList(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAudienceListCallable() + *
+ *
ListAudienceLists

Lists all audience lists for a property. This method can be used for you to find and reuse existing audience lists rather than creating unnecessary new audience lists. The same audience can have multiple audience lists that represent the list of users that were in an audience on different days. + *

See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAudienceLists(ListAudienceListsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAudienceLists(PropertyName parent) + *
  • listAudienceLists(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAudienceListsPagedCallable() + *
  • listAudienceListsCallable() + *
+ *
CreateRecurringAudienceList

Creates a recurring audience list. Recurring audience lists produces new audience lists each day. Audience lists are users in an audience at the time of the list's creation. + *

A recurring audience list ensures that you have audience list based on the most recent data available for use each day. If you manually create audience list, you don't know when an audience list based on an additional day's data is available. This recurring audience list automates the creation of an audience list when an additional day's data is available. You will consume fewer quota tokens by using recurring audience list versus manually creating audience list at various times of day trying to guess when an additional day's data is ready. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createRecurringAudienceList(CreateRecurringAudienceListRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createRecurringAudienceList(PropertyName parent, RecurringAudienceList recurringAudienceList) + *
  • createRecurringAudienceList(String parent, RecurringAudienceList recurringAudienceList) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createRecurringAudienceListCallable() + *
+ *
GetRecurringAudienceList

Gets configuration metadata about a specific recurring audience list. This method can be used to understand a recurring audience list's state after it has been created. For example, a recurring audience list resource will generate audience list instances for each day, and this method can be used to get the resource name of the most recent audience list instance. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getRecurringAudienceList(GetRecurringAudienceListRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getRecurringAudienceList(RecurringAudienceListName name) + *
  • getRecurringAudienceList(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getRecurringAudienceListCallable() + *
+ *
ListRecurringAudienceLists

Lists all recurring audience lists for a property. This method can be used for you to find and reuse existing recurring audience lists rather than creating unnecessary new recurring audience lists. The same audience can have multiple recurring audience lists that represent different dimension combinations; for example, just the dimension `deviceId` or both the dimensions `deviceId` and `userId`. + *

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listRecurringAudienceLists(ListRecurringAudienceListsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listRecurringAudienceLists(PropertyName parent) + *
  • listRecurringAudienceLists(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listRecurringAudienceListsPagedCallable() + *
  • listRecurringAudienceListsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStubSettings.java b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStubSettings.java index 38fdb30d43ba..a82c2cfad54d 100644 --- a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStubSettings.java +++ b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStubSettings.java @@ -365,6 +365,12 @@ public AlphaAnalyticsDataStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "analyticsdata"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/BetaAnalyticsDataClient.java b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/BetaAnalyticsDataClient.java index dac49260b1c0..544938a27230 100644 --- a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/BetaAnalyticsDataClient.java +++ b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/BetaAnalyticsDataClient.java @@ -76,19 +76,209 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
RunReport

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. + *

For a guide to constructing requests & understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • runReport(RunReportRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • runReportCallable() + *
+ *
RunPivotReport

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • runPivotReport(RunPivotReportRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • runPivotReportCallable() + *
+ *
BatchRunReports

Returns multiple reports in a batch. All reports must be for the same GA4 Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchRunReports(BatchRunReportsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchRunReportsCallable() + *
+ *
BatchRunPivotReports

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchRunPivotReports(BatchRunPivotReportsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchRunPivotReportsCallable() + *
+ *
GetMetadata

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. + *

For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMetadata(GetMetadataRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMetadata(MetadataName name) + *
  • getMetadata(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMetadataCallable() + *
+ *
RunRealtimeReport

Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). + *

For a guide to constructing realtime requests & understanding responses, see [Creating a Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • runRealtimeReport(RunRealtimeReportRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • runRealtimeReportCallable() + *
+ *
CheckCompatibility

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. + *

In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. + *

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • checkCompatibility(CheckCompatibilityRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • checkCompatibilityCallable() + *
+ *
CreateAudienceExport

Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the `QueryAudienceExport` method. + *

See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. + *

An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience. + *

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience. + *

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAudienceExportAsync(CreateAudienceExportRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createAudienceExportAsync(PropertyName parent, AudienceExport audienceExport) + *
  • createAudienceExportAsync(String parent, AudienceExport audienceExport) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAudienceExportOperationCallable() + *
  • createAudienceExportCallable() + *
+ *
QueryAudienceExport

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. + *

See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. + *

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. + *

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryAudienceExport(QueryAudienceExportRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • queryAudienceExport(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryAudienceExportCallable() + *
+ *
GetAudienceExport

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. + *

See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. + *

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAudienceExport(GetAudienceExportRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAudienceExport(AudienceExportName name) + *
  • getAudienceExport(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAudienceExportCallable() + *
+ *
ListAudienceExports

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. + *

See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. + *

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAudienceExports(ListAudienceExportsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAudienceExports(PropertyName parent) + *
  • listAudienceExports(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAudienceExportsPagedCallable() + *
  • listAudienceExportsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/stub/BetaAnalyticsDataStubSettings.java b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/stub/BetaAnalyticsDataStubSettings.java index a39cbccb17e4..92379a272467 100644 --- a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/stub/BetaAnalyticsDataStubSettings.java +++ b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1beta/stub/BetaAnalyticsDataStubSettings.java @@ -297,6 +297,12 @@ public BetaAnalyticsDataStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "analyticsdata"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-analyticshub/README.md b/java-analyticshub/README.md index 097b8e4b2a9f..ab627a68dd3a 100644 --- a/java-analyticshub/README.md +++ b/java-analyticshub/README.md @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-preview-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-analyticshub.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-analyticshub/0.27.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-analyticshub/0.29.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/AnalyticsHubServiceClient.java b/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/AnalyticsHubServiceClient.java index 0e66caf94949..c7c598863d5a 100644 --- a/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/AnalyticsHubServiceClient.java +++ b/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/AnalyticsHubServiceClient.java @@ -72,19 +72,422 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListDataExchanges

Lists all data exchanges in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDataExchanges(ListDataExchangesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDataExchanges(LocationName parent) + *
  • listDataExchanges(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDataExchangesPagedCallable() + *
  • listDataExchangesCallable() + *
+ *
ListOrgDataExchanges

Lists all data exchanges from projects in a given organization and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listOrgDataExchanges(ListOrgDataExchangesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listOrgDataExchanges(String organization) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listOrgDataExchangesPagedCallable() + *
  • listOrgDataExchangesCallable() + *
+ *
GetDataExchange

Gets the details of a data exchange.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataExchange(GetDataExchangeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataExchange(DataExchangeName name) + *
  • getDataExchange(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDataExchangeCallable() + *
+ *
CreateDataExchange

Creates a new data exchange.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDataExchange(CreateDataExchangeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDataExchange(LocationName parent, DataExchange dataExchange) + *
  • createDataExchange(String parent, DataExchange dataExchange) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDataExchangeCallable() + *
+ *
UpdateDataExchange

Updates an existing data exchange.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataExchange(UpdateDataExchangeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataExchange(DataExchange dataExchange, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDataExchangeCallable() + *
+ *
DeleteDataExchange

Deletes an existing data exchange.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDataExchange(DeleteDataExchangeRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteDataExchange(DataExchangeName name) + *
  • deleteDataExchange(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDataExchangeCallable() + *
+ *
ListListings

Lists all listings in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listListings(ListListingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listListings(DataExchangeName parent) + *
  • listListings(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listListingsPagedCallable() + *
  • listListingsCallable() + *
+ *
GetListing

Gets the details of a listing.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getListing(GetListingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getListing(ListingName name) + *
  • getListing(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getListingCallable() + *
+ *
CreateListing

Creates a new listing.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createListing(CreateListingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createListing(DataExchangeName parent, Listing listing) + *
  • createListing(String parent, Listing listing) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createListingCallable() + *
+ *
UpdateListing

Updates an existing listing.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateListing(UpdateListingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateListing(Listing listing, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateListingCallable() + *
+ *
DeleteListing

Deletes a listing.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteListing(DeleteListingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteListing(ListingName name) + *
  • deleteListing(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteListingCallable() + *
+ *
SubscribeListing

Subscribes to a listing. + *

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • subscribeListing(SubscribeListingRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • subscribeListing(ListingName name) + *
  • subscribeListing(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • subscribeListingCallable() + *
+ *
SubscribeDataExchange

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • subscribeDataExchangeAsync(SubscribeDataExchangeRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • subscribeDataExchangeAsync(DataExchangeName name) + *
  • subscribeDataExchangeAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • subscribeDataExchangeOperationCallable() + *
  • subscribeDataExchangeCallable() + *
+ *
RefreshSubscription

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • refreshSubscriptionAsync(RefreshSubscriptionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • refreshSubscriptionAsync(SubscriptionName name) + *
  • refreshSubscriptionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • refreshSubscriptionOperationCallable() + *
  • refreshSubscriptionCallable() + *
+ *
GetSubscription

Gets the details of a Subscription.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSubscription(GetSubscriptionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSubscription(SubscriptionName name) + *
  • getSubscription(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSubscriptionCallable() + *
+ *
ListSubscriptions

Lists all subscriptions in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSubscriptions(ListSubscriptionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSubscriptions(LocationName parent) + *
  • listSubscriptions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSubscriptionsPagedCallable() + *
  • listSubscriptionsCallable() + *
+ *
ListSharedResourceSubscriptions

Lists all subscriptions on a given Data Exchange or Listing.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSharedResourceSubscriptions(ResourceName resource) + *
  • listSharedResourceSubscriptions(String resource) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSharedResourceSubscriptionsPagedCallable() + *
  • listSharedResourceSubscriptionsCallable() + *
+ *
RevokeSubscription

Revokes a given subscription.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • revokeSubscription(RevokeSubscriptionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • revokeSubscription(SubscriptionName name) + *
  • revokeSubscription(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • revokeSubscriptionCallable() + *
+ *
DeleteSubscription

Deletes a subscription.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSubscriptionAsync(DeleteSubscriptionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteSubscriptionAsync(SubscriptionName name) + *
  • deleteSubscriptionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSubscriptionOperationCallable() + *
  • deleteSubscriptionCallable() + *
+ *
GetIamPolicy

Gets the IAM policy.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
SetIamPolicy

Sets the IAM policy.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
TestIamPermissions

Returns the permissions that a caller has.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/stub/AnalyticsHubServiceStubSettings.java b/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/stub/AnalyticsHubServiceStubSettings.java index 57070cfe0090..df8b3549bf55 100644 --- a/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/stub/AnalyticsHubServiceStubSettings.java +++ b/java-analyticshub/google-cloud-analyticshub/src/main/java/com/google/cloud/bigquery/analyticshub/v1/stub/AnalyticsHubServiceStubSettings.java @@ -681,6 +681,12 @@ public AnalyticsHubServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "analyticshub"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-api-gateway/README.md b/java-api-gateway/README.md index ab4e19daa585..e903d234a67b 100644 --- a/java-api-gateway/README.md +++ b/java-api-gateway/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-api-gateway.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-api-gateway/2.30.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-api-gateway/2.32.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/ApiGatewayServiceClient.java b/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/ApiGatewayServiceClient.java index 4ac3132ec06a..fbde6ecec020 100644 --- a/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/ApiGatewayServiceClient.java +++ b/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/ApiGatewayServiceClient.java @@ -62,19 +62,307 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListGateways

Lists Gateways in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listGateways(ListGatewaysRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listGateways(LocationName parent) + *
  • listGateways(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listGatewaysPagedCallable() + *
  • listGatewaysCallable() + *
+ *
GetGateway

Gets details of a single Gateway.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getGateway(GetGatewayRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getGateway(GatewayName name) + *
  • getGateway(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getGatewayCallable() + *
+ *
CreateGateway

Creates a new Gateway in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createGatewayAsync(CreateGatewayRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createGatewayAsync(LocationName parent, Gateway gateway, String gatewayId) + *
  • createGatewayAsync(String parent, Gateway gateway, String gatewayId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createGatewayOperationCallable() + *
  • createGatewayCallable() + *
+ *
UpdateGateway

Updates the parameters of a single Gateway.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateGatewayAsync(UpdateGatewayRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateGatewayAsync(Gateway gateway, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateGatewayOperationCallable() + *
  • updateGatewayCallable() + *
+ *
DeleteGateway

Deletes a single Gateway.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteGatewayAsync(DeleteGatewayRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteGatewayAsync(GatewayName name) + *
  • deleteGatewayAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteGatewayOperationCallable() + *
  • deleteGatewayCallable() + *
+ *
ListApis

Lists Apis in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApis(ListApisRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listApis(LocationName parent) + *
  • listApis(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApisPagedCallable() + *
  • listApisCallable() + *
+ *
GetApi

Gets details of a single Api.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApi(GetApiRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApi(ApiName name) + *
  • getApi(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApiCallable() + *
+ *
CreateApi

Creates a new Api in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createApiAsync(CreateApiRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createApiAsync(LocationName parent, Api api, String apiId) + *
  • createApiAsync(String parent, Api api, String apiId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createApiOperationCallable() + *
  • createApiCallable() + *
+ *
UpdateApi

Updates the parameters of a single Api.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateApiAsync(UpdateApiRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateApiAsync(Api api, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateApiOperationCallable() + *
  • updateApiCallable() + *
+ *
DeleteApi

Deletes a single Api.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApiAsync(DeleteApiRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteApiAsync(ApiName name) + *
  • deleteApiAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiOperationCallable() + *
  • deleteApiCallable() + *
+ *
ListApiConfigs

Lists ApiConfigs in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApiConfigs(ListApiConfigsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listApiConfigs(ApiName parent) + *
  • listApiConfigs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApiConfigsPagedCallable() + *
  • listApiConfigsCallable() + *
+ *
GetApiConfig

Gets details of a single ApiConfig.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApiConfig(GetApiConfigRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApiConfig(ApiConfigName name) + *
  • getApiConfig(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApiConfigCallable() + *
+ *
CreateApiConfig

Creates a new ApiConfig in a given project and location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createApiConfigAsync(CreateApiConfigRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createApiConfigAsync(ApiName parent, ApiConfig apiConfig, String apiConfigId) + *
  • createApiConfigAsync(String parent, ApiConfig apiConfig, String apiConfigId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createApiConfigOperationCallable() + *
  • createApiConfigCallable() + *
+ *
UpdateApiConfig

Updates the parameters of a single ApiConfig.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateApiConfigAsync(UpdateApiConfigRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateApiConfigAsync(ApiConfig apiConfig, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateApiConfigOperationCallable() + *
  • updateApiConfigCallable() + *
+ *
DeleteApiConfig

Deletes a single ApiConfig.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApiConfigAsync(DeleteApiConfigRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteApiConfigAsync(ApiConfigName name) + *
  • deleteApiConfigAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiConfigOperationCallable() + *
  • deleteApiConfigCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/stub/ApiGatewayServiceStubSettings.java b/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/stub/ApiGatewayServiceStubSettings.java index 8bf36efe89d1..af0be9408c93 100644 --- a/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/stub/ApiGatewayServiceStubSettings.java +++ b/java-api-gateway/google-cloud-api-gateway/src/main/java/com/google/cloud/apigateway/v1/stub/ApiGatewayServiceStubSettings.java @@ -473,6 +473,12 @@ public ApiGatewayServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "apigateway"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-apigee-connect/README.md b/java-apigee-connect/README.md index c5b99658ab34..5dd56a551efd 100644 --- a/java-apigee-connect/README.md +++ b/java-apigee-connect/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-apigee-connect.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-apigee-connect/2.30.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-apigee-connect/2.32.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java index 0254061ebee5..691af68c6920 100644 --- a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java +++ b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java @@ -57,19 +57,33 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListConnections

Lists connections that are currently active for the given Apigee Connect endpoint.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listConnections(ListConnectionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listConnections(EndpointName parent) + *
  • listConnections(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listConnectionsPagedCallable() + *
  • listConnectionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/TetherClient.java b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/TetherClient.java index d085337c3239..587dff88f084 100644 --- a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/TetherClient.java +++ b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/TetherClient.java @@ -61,19 +61,23 @@ *

Note: close() needs to be called on the TetherClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
Egress

Egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses.

 + *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • egressCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/ConnectionServiceStubSettings.java b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/ConnectionServiceStubSettings.java index a037feaf5fee..4b300a889808 100644 --- a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/ConnectionServiceStubSettings.java +++ b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/ConnectionServiceStubSettings.java @@ -182,6 +182,12 @@ public ConnectionServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "apigeeconnect"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/TetherStubSettings.java b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/TetherStubSettings.java index cde1caba7e18..2198f7ed4489 100644 --- a/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/TetherStubSettings.java +++ b/java-apigee-connect/google-cloud-apigee-connect/src/main/java/com/google/cloud/apigeeconnect/v1/stub/TetherStubSettings.java @@ -102,6 +102,12 @@ public TetherStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "apigeeconnect"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-apigee-registry/README.md b/java-apigee-registry/README.md index bde9f67c49f8..c430244fc972 100644 --- a/java-apigee-registry/README.md +++ b/java-apigee-registry/README.md @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-preview-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-apigee-registry.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-apigee-registry/0.30.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-apigee-registry/0.32.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/ProvisioningClient.java b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/ProvisioningClient.java index 27a524abbc74..040208c3c8da 100644 --- a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/ProvisioningClient.java +++ b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/ProvisioningClient.java @@ -70,19 +70,145 @@ *

Note: close() needs to be called on the ProvisioningClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateInstance

Provisions instance resources for the Registry.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createInstanceAsync(CreateInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createInstanceAsync(LocationName parent, Instance instance, String instanceId) + *
  • createInstanceAsync(String parent, Instance instance, String instanceId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createInstanceOperationCallable() + *
  • createInstanceCallable() + *
+ *
DeleteInstance

Deletes the Registry instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteInstanceAsync(DeleteInstanceRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteInstanceAsync(InstanceName name) + *
  • deleteInstanceAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteInstanceOperationCallable() + *
  • deleteInstanceCallable() + *
+ *
GetInstance

Gets details of a single Instance.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getInstance(GetInstanceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getInstance(InstanceName name) + *
  • getInstance(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getInstanceCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/RegistryClient.java b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/RegistryClient.java index e33e63d6b57e..67c91164d5bf 100644 --- a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/RegistryClient.java +++ b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/RegistryClient.java @@ -66,19 +66,731 @@ *

Note: close() needs to be called on the RegistryClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListApis

Returns matching APIs.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApis(ListApisRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listApis(LocationName parent) + *
  • listApis(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApisPagedCallable() + *
  • listApisCallable() + *
+ *
GetApi

Returns a specified API.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApi(GetApiRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApi(ApiName name) + *
  • getApi(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApiCallable() + *
+ *
CreateApi

Creates a specified API.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createApi(CreateApiRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createApi(LocationName parent, Api api, String apiId) + *
  • createApi(String parent, Api api, String apiId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createApiCallable() + *
+ *
UpdateApi

Used to modify a specified API.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateApi(UpdateApiRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateApi(Api api, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateApiCallable() + *
+ *
DeleteApi

Removes a specified API and all of the resources that it owns.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApi(DeleteApiRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteApi(ApiName name) + *
  • deleteApi(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiCallable() + *
+ *
ListApiVersions

Returns matching versions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApiVersions(ListApiVersionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listApiVersions(ApiName parent) + *
  • listApiVersions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApiVersionsPagedCallable() + *
  • listApiVersionsCallable() + *
+ *
GetApiVersion

Returns a specified version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApiVersion(GetApiVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApiVersion(ApiVersionName name) + *
  • getApiVersion(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApiVersionCallable() + *
+ *
CreateApiVersion

Creates a specified version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createApiVersion(CreateApiVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createApiVersion(ApiName parent, ApiVersion apiVersion, String apiVersionId) + *
  • createApiVersion(String parent, ApiVersion apiVersion, String apiVersionId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createApiVersionCallable() + *
+ *
UpdateApiVersion

Used to modify a specified version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateApiVersion(UpdateApiVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateApiVersion(ApiVersion apiVersion, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateApiVersionCallable() + *
+ *
DeleteApiVersion

Removes a specified version and all of the resources that it owns.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApiVersion(DeleteApiVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteApiVersion(ApiVersionName name) + *
  • deleteApiVersion(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiVersionCallable() + *
+ *
ListApiSpecs

Returns matching specs.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApiSpecs(ListApiSpecsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listApiSpecs(ApiVersionName parent) + *
  • listApiSpecs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApiSpecsPagedCallable() + *
  • listApiSpecsCallable() + *
+ *
GetApiSpec

Returns a specified spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApiSpec(GetApiSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApiSpec(ApiSpecName name) + *
  • getApiSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApiSpecCallable() + *
+ *
GetApiSpecContents

Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApiSpecContents(GetApiSpecContentsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApiSpecContents(ApiSpecName name) + *
  • getApiSpecContents(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApiSpecContentsCallable() + *
+ *
CreateApiSpec

Creates a specified spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createApiSpec(CreateApiSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createApiSpec(ApiVersionName parent, ApiSpec apiSpec, String apiSpecId) + *
  • createApiSpec(String parent, ApiSpec apiSpec, String apiSpecId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createApiSpecCallable() + *
+ *
UpdateApiSpec

Used to modify a specified spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateApiSpec(UpdateApiSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateApiSpec(ApiSpec apiSpec, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateApiSpecCallable() + *
+ *
DeleteApiSpec

Removes a specified spec, all revisions, and all child resources (e.g., artifacts).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApiSpec(DeleteApiSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteApiSpec(ApiSpecName name) + *
  • deleteApiSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiSpecCallable() + *
+ *
TagApiSpecRevision

Adds a tag to a specified revision of a spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • tagApiSpecRevision(TagApiSpecRevisionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • tagApiSpecRevisionCallable() + *
+ *
ListApiSpecRevisions

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApiSpecRevisions(ListApiSpecRevisionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApiSpecRevisionsPagedCallable() + *
  • listApiSpecRevisionsCallable() + *
+ *
RollbackApiSpec

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • rollbackApiSpec(RollbackApiSpecRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • rollbackApiSpecCallable() + *
+ *
DeleteApiSpecRevision

Deletes a revision of a spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApiSpecRevision(DeleteApiSpecRevisionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteApiSpecRevision(ApiSpecName name) + *
  • deleteApiSpecRevision(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiSpecRevisionCallable() + *
+ *
ListApiDeployments

Returns matching deployments.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApiDeployments(ListApiDeploymentsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listApiDeployments(ApiName parent) + *
  • listApiDeployments(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApiDeploymentsPagedCallable() + *
  • listApiDeploymentsCallable() + *
+ *
GetApiDeployment

Returns a specified deployment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApiDeployment(GetApiDeploymentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApiDeployment(ApiDeploymentName name) + *
  • getApiDeployment(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApiDeploymentCallable() + *
+ *
CreateApiDeployment

Creates a specified deployment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createApiDeployment(CreateApiDeploymentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createApiDeployment(ApiName parent, ApiDeployment apiDeployment, String apiDeploymentId) + *
  • createApiDeployment(String parent, ApiDeployment apiDeployment, String apiDeploymentId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createApiDeploymentCallable() + *
+ *
UpdateApiDeployment

Used to modify a specified deployment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateApiDeployment(UpdateApiDeploymentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateApiDeployment(ApiDeployment apiDeployment, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateApiDeploymentCallable() + *
+ *
DeleteApiDeployment

Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApiDeployment(DeleteApiDeploymentRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteApiDeployment(ApiDeploymentName name) + *
  • deleteApiDeployment(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiDeploymentCallable() + *
+ *
TagApiDeploymentRevision

Adds a tag to a specified revision of a deployment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • tagApiDeploymentRevision(TagApiDeploymentRevisionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • tagApiDeploymentRevisionCallable() + *
+ *
ListApiDeploymentRevisions

Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listApiDeploymentRevisionsPagedCallable() + *
  • listApiDeploymentRevisionsCallable() + *
+ *
RollbackApiDeployment

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • rollbackApiDeployment(RollbackApiDeploymentRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • rollbackApiDeploymentCallable() + *
+ *
DeleteApiDeploymentRevision

Deletes a revision of a deployment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteApiDeploymentRevision(ApiDeploymentName name) + *
  • deleteApiDeploymentRevision(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteApiDeploymentRevisionCallable() + *
+ *
ListArtifacts

Returns matching artifacts.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listArtifacts(ListArtifactsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listArtifacts(ApiDeploymentName parent) + *
  • listArtifacts(ApiName parent) + *
  • listArtifacts(ApiSpecName parent) + *
  • listArtifacts(ApiVersionName parent) + *
  • listArtifacts(LocationName parent) + *
  • listArtifacts(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listArtifactsPagedCallable() + *
  • listArtifactsCallable() + *
+ *
GetArtifact

Returns a specified artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getArtifact(GetArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getArtifact(ArtifactName name) + *
  • getArtifact(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getArtifactCallable() + *
+ *
GetArtifactContents

Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getArtifactContents(GetArtifactContentsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getArtifactContents(ArtifactName name) + *
  • getArtifactContents(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getArtifactContentsCallable() + *
+ *
CreateArtifact

Creates a specified artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createArtifact(CreateArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createArtifact(ApiDeploymentName parent, Artifact artifact, String artifactId) + *
  • createArtifact(ApiName parent, Artifact artifact, String artifactId) + *
  • createArtifact(ApiSpecName parent, Artifact artifact, String artifactId) + *
  • createArtifact(ApiVersionName parent, Artifact artifact, String artifactId) + *
  • createArtifact(LocationName parent, Artifact artifact, String artifactId) + *
  • createArtifact(String parent, Artifact artifact, String artifactId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createArtifactCallable() + *
+ *
ReplaceArtifact

Used to replace a specified artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • replaceArtifact(ReplaceArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • replaceArtifact(Artifact artifact) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • replaceArtifactCallable() + *
+ *
DeleteArtifact

Removes a specified artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteArtifact(DeleteArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteArtifact(ArtifactName name) + *
  • deleteArtifact(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteArtifactCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. + *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. + *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/ProvisioningStubSettings.java b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/ProvisioningStubSettings.java index 5a96d176691d..4e5b1da8f686 100644 --- a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/ProvisioningStubSettings.java +++ b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/ProvisioningStubSettings.java @@ -255,6 +255,12 @@ public ProvisioningStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "apigeeregistry"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/RegistryStubSettings.java b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/RegistryStubSettings.java index f496b7990f22..ec8c2a9af59d 100644 --- a/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/RegistryStubSettings.java +++ b/java-apigee-registry/google-cloud-apigee-registry/src/main/java/com/google/cloud/apigeeregistry/v1/stub/RegistryStubSettings.java @@ -931,6 +931,12 @@ public RegistryStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "apigeeregistry"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-apikeys/README.md b/java-apikeys/README.md index 1ee52a8bad83..4e96e98a81f9 100644 --- a/java-apikeys/README.md +++ b/java-apikeys/README.md @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-preview-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-apikeys.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-apikeys/0.28.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-apikeys/0.30.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/ApiKeysClient.java b/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/ApiKeysClient.java index 1065ba75eed0..98974a9e900b 100644 --- a/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/ApiKeysClient.java +++ b/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/ApiKeysClient.java @@ -61,19 +61,166 @@ *

Note: close() needs to be called on the ApiKeysClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateKey

Creates a new API key. + *

NOTE: Key is a global resource; hence the only supported value for location is `global`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createKeyAsync(CreateKeyRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createKeyAsync(LocationName parent, Key key, String keyId) + *
  • createKeyAsync(String parent, Key key, String keyId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createKeyOperationCallable() + *
  • createKeyCallable() + *
+ *
ListKeys

Lists the API keys owned by a project. The key string of the API key isn't included in the response. + *

NOTE: Key is a global resource; hence the only supported value for location is `global`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listKeys(ListKeysRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listKeys(LocationName parent) + *
  • listKeys(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listKeysPagedCallable() + *
  • listKeysCallable() + *
+ *
GetKey

Gets the metadata for an API key. The key string of the API key isn't included in the response. + *

NOTE: Key is a global resource; hence the only supported value for location is `global`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getKey(GetKeyRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getKey(KeyName name) + *
  • getKey(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getKeyCallable() + *
+ *
GetKeyString

Get the key string for an API key. + *

NOTE: Key is a global resource; hence the only supported value for location is `global`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getKeyString(GetKeyStringRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getKeyString(KeyName name) + *
  • getKeyString(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getKeyStringCallable() + *
+ *
UpdateKey

Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. + *

NOTE: Key is a global resource; hence the only supported value for location is `global`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateKeyAsync(UpdateKeyRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • updateKeyAsync(Key key, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateKeyOperationCallable() + *
  • updateKeyCallable() + *
+ *
DeleteKey

Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. + *

NOTE: Key is a global resource; hence the only supported value for location is `global`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteKeyAsync(DeleteKeyRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteKeyAsync(KeyName name) + *
  • deleteKeyAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteKeyOperationCallable() + *
  • deleteKeyCallable() + *
+ *
UndeleteKey

Undeletes an API key which was deleted within 30 days. + *

NOTE: Key is a global resource; hence the only supported value for location is `global`.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • undeleteKeyAsync(UndeleteKeyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • undeleteKeyOperationCallable() + *
  • undeleteKeyCallable() + *
+ *
LookupKey

Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • lookupKey(LookupKeyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • lookupKeyCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/stub/ApiKeysStubSettings.java b/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/stub/ApiKeysStubSettings.java index 6d2d512d0fef..c725ecad939c 100644 --- a/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/stub/ApiKeysStubSettings.java +++ b/java-apikeys/google-cloud-apikeys/src/main/java/com/google/api/apikeys/v2/stub/ApiKeysStubSettings.java @@ -258,6 +258,12 @@ public ApiKeysStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "apikeys"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/README.md b/java-appengine-admin/README.md index ad07e81ce133..e03e4b4f184d 100644 --- a/java-appengine-admin/README.md +++ b/java-appengine-admin/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-appengine-admin.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-appengine-admin/2.30.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-appengine-admin/2.32.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ApplicationsClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ApplicationsClient.java index cdc9d399022e..0b3af0ff961c 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ApplicationsClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ApplicationsClient.java @@ -51,19 +51,86 @@ *

Note: close() needs to be called on the ApplicationsClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
GetApplication

Gets information about an application.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getApplication(GetApplicationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getApplication(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getApplicationCallable() + *
+ *
CreateApplication

Creates an App Engine application for a Google Cloud Platform project. Required fields: + *

    + *
  • `id` - The ID of the target Cloud Platform project. + *
  • *location* - The [region](https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located. + *
+ *

For more information about App Engine applications, see [Managing Projects, Applications, and Billing](https://cloud.google.com/appengine/docs/standard/python/console/).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createApplicationAsync(CreateApplicationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createApplicationOperationCallable() + *
  • createApplicationCallable() + *
+ *
UpdateApplication

Updates the specified Application resource. You can update the following fields: + *

    + *
  • `auth_domain` - Google authentication domain for controlling user access to the application. + *
  • `default_cookie_expiration` - Cookie expiration policy for the application. + *
  • `iap` - Identity-Aware Proxy properties for the application. + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateApplicationAsync(UpdateApplicationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateApplicationOperationCallable() + *
  • updateApplicationCallable() + *
+ *
RepairApplication

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, *Error retrieving the App Engine service account*. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • repairApplicationAsync(RepairApplicationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • repairApplicationOperationCallable() + *
  • repairApplicationCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedCertificatesClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedCertificatesClient.java index 6f85ae8b688f..d7b9af759164 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedCertificatesClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedCertificatesClient.java @@ -63,19 +63,84 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListAuthorizedCertificates

Lists all SSL certificates the user is authorized to administer.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAuthorizedCertificates(ListAuthorizedCertificatesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAuthorizedCertificatesPagedCallable() + *
  • listAuthorizedCertificatesCallable() + *
+ *
GetAuthorizedCertificate

Gets the specified SSL certificate.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAuthorizedCertificate(GetAuthorizedCertificateRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAuthorizedCertificateCallable() + *
+ *
CreateAuthorizedCertificate

Uploads the specified SSL certificate.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createAuthorizedCertificate(CreateAuthorizedCertificateRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createAuthorizedCertificateCallable() + *
+ *
UpdateAuthorizedCertificate

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update `certificate_data` with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate `display_name` may also be updated.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateAuthorizedCertificate(UpdateAuthorizedCertificateRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateAuthorizedCertificateCallable() + *
+ *
DeleteAuthorizedCertificate

Deletes the specified SSL certificate.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteAuthorizedCertificate(DeleteAuthorizedCertificateRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteAuthorizedCertificateCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedDomainsClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedDomainsClient.java index 3cebc3fe40e8..7f9effc30ddd 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedDomainsClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/AuthorizedDomainsClient.java @@ -65,19 +65,28 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListAuthorizedDomains

Lists all domains the user is authorized to administer.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAuthorizedDomains(ListAuthorizedDomainsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAuthorizedDomainsPagedCallable() + *
  • listAuthorizedDomainsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/DomainMappingsClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/DomainMappingsClient.java index 423e6d9ead47..1791b70febf5 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/DomainMappingsClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/DomainMappingsClient.java @@ -61,19 +61,87 @@ *

Note: close() needs to be called on the DomainMappingsClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListDomainMappings

Lists the domain mappings on an application.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDomainMappings(ListDomainMappingsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDomainMappingsPagedCallable() + *
  • listDomainMappingsCallable() + *
+ *
GetDomainMapping

Gets the specified domain mapping.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDomainMapping(GetDomainMappingRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDomainMappingCallable() + *
+ *
CreateDomainMapping

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see [`AuthorizedDomains.ListAuthorizedDomains`]().

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDomainMappingAsync(CreateDomainMappingRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDomainMappingOperationCallable() + *
  • createDomainMappingCallable() + *
+ *
UpdateDomainMapping

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update `certificate_id` to point to an `AuthorizedCertificate` resource. A user must be authorized to administer the associated domain in order to update a `DomainMapping` resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDomainMappingAsync(UpdateDomainMappingRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDomainMappingOperationCallable() + *
  • updateDomainMappingCallable() + *
+ *
DeleteDomainMapping

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a `DomainMapping` resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDomainMappingAsync(DeleteDomainMappingRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDomainMappingOperationCallable() + *
  • deleteDomainMappingCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/FirewallClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/FirewallClient.java index f2bb360d0548..27a469d69c36 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/FirewallClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/FirewallClient.java @@ -68,19 +68,99 @@ *

Note: close() needs to be called on the FirewallClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListIngressRules

Lists the firewall rules of an application.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listIngressRules(ListIngressRulesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listIngressRulesPagedCallable() + *
  • listIngressRulesCallable() + *
+ *
BatchUpdateIngressRules

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules. + *

If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchUpdateIngressRules(BatchUpdateIngressRulesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchUpdateIngressRulesCallable() + *
+ *
CreateIngressRule

Creates a firewall rule for the application.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createIngressRule(CreateIngressRuleRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createIngressRuleCallable() + *
+ *
GetIngressRule

Gets the specified firewall rule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIngressRule(GetIngressRuleRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIngressRuleCallable() + *
+ *
UpdateIngressRule

Updates the specified firewall rule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateIngressRule(UpdateIngressRuleRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateIngressRuleCallable() + *
+ *
DeleteIngressRule

Deletes the specified firewall rule.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteIngressRule(DeleteIngressRuleRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteIngressRuleCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/InstancesClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/InstancesClient.java index f0c95490d582..8ab64c12e3c9 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/InstancesClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/InstancesClient.java @@ -60,19 +60,76 @@ *

Note: close() needs to be called on the InstancesClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListInstances

Lists the instances of a version. + *

Tip: To aggregate details about instances over time, see the [Stackdriver Monitoring API](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listInstances(ListInstancesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listInstancesPagedCallable() + *
  • listInstancesCallable() + *
+ *
GetInstance

Gets instance information.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getInstance(GetInstanceRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getInstanceCallable() + *
+ *
DeleteInstance

Stops a running instance. + *

The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" ([standard environment](https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | [flexible environment](https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)). + *

To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to `STOPPED` with the [`apps.services.versions.patch`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteInstanceAsync(DeleteInstanceRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteInstanceOperationCallable() + *
  • deleteInstanceCallable() + *
+ *
DebugInstance

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. + *

Only applicable for instances in App Engine flexible environment.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • debugInstanceAsync(DebugInstanceRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • debugInstanceOperationCallable() + *
  • debugInstanceCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ServicesClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ServicesClient.java index 49627f53b8af..6bce79b97403 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ServicesClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/ServicesClient.java @@ -60,19 +60,72 @@ *

Note: close() needs to be called on the ServicesClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListServices

Lists all the services in the application.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listServices(ListServicesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listServicesPagedCallable() + *
  • listServicesCallable() + *
+ *
GetService

Gets the current configuration of the specified service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getService(GetServiceRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getServiceCallable() + *
+ *
UpdateService

Updates the configuration of the specified service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateServiceAsync(UpdateServiceRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateServiceOperationCallable() + *
  • updateServiceCallable() + *
+ *
DeleteService

Deletes the specified service and all enclosed versions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteServiceAsync(DeleteServiceRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteServiceOperationCallable() + *
  • deleteServiceCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/VersionsClient.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/VersionsClient.java index 75c711a4c4dc..8def37a47ee1 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/VersionsClient.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/VersionsClient.java @@ -64,19 +64,120 @@ *

Note: close() needs to be called on the VersionsClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListVersions

Lists the versions of a service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listVersions(ListVersionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listVersionsPagedCallable() + *
  • listVersionsCallable() + *
+ *
GetVersion

Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getVersion(GetVersionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getVersionCallable() + *
+ *
CreateVersion

Deploys code and resource files to a new version.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createVersionAsync(CreateVersionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createVersionOperationCallable() + *
  • createVersionCallable() + *
+ *
UpdateVersion

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: + *

**Standard environment** + *

    + *
  • [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class) + *
+ *

*automatic scaling* in the standard environment: + *

    + *
  • [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + *
  • [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + *
  • [`automaticScaling.standard_scheduler_settings.max_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) + *
  • [`automaticScaling.standard_scheduler_settings.min_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) + *
  • [`automaticScaling.standard_scheduler_settings.target_cpu_utilization`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) + *
  • [`automaticScaling.standard_scheduler_settings.target_throughput_utilization`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) + *
+ *

*basic scaling* or *manual scaling* in the standard environment: + *

    + *
  • [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) + *
  • [`manual_scaling.instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling) + *
+ *

**Flexible environment** + *

    + *
  • [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) + *
+ *

*automatic scaling* in the flexible environment: + *

    + *
  • [`automatic_scaling.min_total_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + *
  • [`automatic_scaling.max_total_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + *
  • [`automatic_scaling.cool_down_period_sec`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + *
  • [`automatic_scaling.cpu_utilization.target_utilization`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + *
+ *

*manual scaling* in the flexible environment: + *

    + *
  • [`manual_scaling.instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling) + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateVersionAsync(UpdateVersionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateVersionOperationCallable() + *
  • updateVersionCallable() + *
+ *
DeleteVersion

Deletes an existing Version resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteVersionAsync(DeleteVersionRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteVersionOperationCallable() + *
  • deleteVersionCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ApplicationsStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ApplicationsStubSettings.java index d03a7d041741..effe794993e6 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ApplicationsStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ApplicationsStubSettings.java @@ -166,6 +166,12 @@ public ApplicationsStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedCertificatesStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedCertificatesStubSettings.java index 98f76502db46..a610950a9ca8 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedCertificatesStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedCertificatesStubSettings.java @@ -249,6 +249,12 @@ public AuthorizedCertificatesStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedDomainsStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedDomainsStubSettings.java index b6de2eb07bdf..99a56c105e67 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedDomainsStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/AuthorizedDomainsStubSettings.java @@ -199,6 +199,12 @@ public AuthorizedDomainsStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/DomainMappingsStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/DomainMappingsStubSettings.java index f681139d0f7a..2eec0247c389 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/DomainMappingsStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/DomainMappingsStubSettings.java @@ -254,6 +254,12 @@ public DomainMappingsStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/FirewallStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/FirewallStubSettings.java index d6919141c63a..08b149689ce0 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/FirewallStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/FirewallStubSettings.java @@ -226,6 +226,12 @@ public FirewallStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/InstancesStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/InstancesStubSettings.java index c7ecc83d2b75..18d960e845b3 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/InstancesStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/InstancesStubSettings.java @@ -224,6 +224,12 @@ public InstancesStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ServicesStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ServicesStubSettings.java index 1f262baad622..d00e176d8f8d 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ServicesStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/ServicesStubSettings.java @@ -224,6 +224,12 @@ public ServicesStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/VersionsStubSettings.java b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/VersionsStubSettings.java index e228b1af245c..d0ed0333c99a 100644 --- a/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/VersionsStubSettings.java +++ b/java-appengine-admin/google-cloud-appengine-admin/src/main/java/com/google/appengine/v1/stub/VersionsStubSettings.java @@ -240,6 +240,12 @@ public VersionsStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "appengine"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-area120-tables/README.md b/java-area120-tables/README.md index b0ab60db14c7..681b9953bbf4 100644 --- a/java-area120-tables/README.md +++ b/java-area120-tables/README.md @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-preview-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.area120/google-area120-tables.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.area120/google-area120-tables/0.34.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.area120/google-area120-tables/0.36.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/TablesServiceClient.java b/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/TablesServiceClient.java index 6935cc2130a0..8274168f6f04 100644 --- a/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/TablesServiceClient.java +++ b/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/TablesServiceClient.java @@ -90,19 +90,216 @@ *

Note: close() needs to be called on the TablesServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
GetTable

Gets a table. Returns NOT_FOUND if the table does not exist.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTable(GetTableRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTable(TableName name) + *
  • getTable(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTableCallable() + *
+ *
ListTables

Lists tables for the user.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTables(ListTablesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTablesPagedCallable() + *
  • listTablesCallable() + *
+ *
GetWorkspace

Gets a workspace. Returns NOT_FOUND if the workspace does not exist.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getWorkspace(GetWorkspaceRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getWorkspace(WorkspaceName name) + *
  • getWorkspace(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getWorkspaceCallable() + *
+ *
ListWorkspaces

Lists workspaces for the user.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listWorkspaces(ListWorkspacesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listWorkspacesPagedCallable() + *
  • listWorkspacesCallable() + *
+ *
GetRow

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getRow(GetRowRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getRow(RowName name) + *
  • getRow(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getRowCallable() + *
+ *
ListRows

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listRows(ListRowsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listRows(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listRowsPagedCallable() + *
  • listRowsCallable() + *
+ *
CreateRow

Creates a row.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createRow(CreateRowRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createRow(String parent, Row row) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createRowCallable() + *
+ *
BatchCreateRows

Creates multiple rows.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchCreateRows(BatchCreateRowsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchCreateRowsCallable() + *
+ *
UpdateRow

Updates a row.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateRow(UpdateRowRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateRow(Row row, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateRowCallable() + *
+ *
BatchUpdateRows

Updates multiple rows.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchUpdateRows(BatchUpdateRowsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchUpdateRowsCallable() + *
+ *
DeleteRow

Deletes a row.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteRow(DeleteRowRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteRow(RowName name) + *
  • deleteRow(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteRowCallable() + *
+ *
BatchDeleteRows

Deletes multiple rows.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchDeleteRows(BatchDeleteRowsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchDeleteRowsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/stub/TablesServiceStubSettings.java b/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/stub/TablesServiceStubSettings.java index a07e33161720..0672c07dd0d4 100644 --- a/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/stub/TablesServiceStubSettings.java +++ b/java-area120-tables/google-area120-tables/src/main/java/com/google/area120/tables/v1alpha/stub/TablesServiceStubSettings.java @@ -386,6 +386,12 @@ public TablesServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "area120tables"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-artifact-registry/README.md b/java-artifact-registry/README.md index f9c589369826..abd75e84d015 100644 --- a/java-artifact-registry/README.md +++ b/java-artifact-registry/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-artifact-registry.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-artifact-registry/1.29.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-artifact-registry/1.31.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/ArtifactRegistryClient.java b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/ArtifactRegistryClient.java index 80c524c11d2b..fe533816f49a 100644 --- a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/ArtifactRegistryClient.java +++ b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/ArtifactRegistryClient.java @@ -85,19 +85,705 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListDockerImages

Lists docker images.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDockerImages(ListDockerImagesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDockerImages(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDockerImagesPagedCallable() + *
  • listDockerImagesCallable() + *
+ *
GetDockerImage

Gets a docker image.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDockerImage(GetDockerImageRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDockerImage(DockerImageName name) + *
  • getDockerImage(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDockerImageCallable() + *
+ *
ListMavenArtifacts

Lists maven artifacts.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listMavenArtifacts(ListMavenArtifactsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listMavenArtifacts(RepositoryName parent) + *
  • listMavenArtifacts(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listMavenArtifactsPagedCallable() + *
  • listMavenArtifactsCallable() + *
+ *
GetMavenArtifact

Gets a maven artifact.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getMavenArtifact(GetMavenArtifactRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getMavenArtifact(MavenArtifactName name) + *
  • getMavenArtifact(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getMavenArtifactCallable() + *
+ *
ListNpmPackages

Lists npm packages.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listNpmPackages(ListNpmPackagesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listNpmPackages(RepositoryName parent) + *
  • listNpmPackages(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listNpmPackagesPagedCallable() + *
  • listNpmPackagesCallable() + *
+ *
GetNpmPackage

Gets a npm package.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getNpmPackage(GetNpmPackageRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getNpmPackage(NpmPackageName name) + *
  • getNpmPackage(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getNpmPackageCallable() + *
+ *
ListPythonPackages

Lists python packages.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listPythonPackages(ListPythonPackagesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listPythonPackages(RepositoryName parent) + *
  • listPythonPackages(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPythonPackagesPagedCallable() + *
  • listPythonPackagesCallable() + *
+ *
GetPythonPackage

Gets a python package.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPythonPackage(GetPythonPackageRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPythonPackage(PythonPackageName name) + *
  • getPythonPackage(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPythonPackageCallable() + *
+ *
ImportAptArtifacts

Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importAptArtifactsAsync(ImportAptArtifactsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importAptArtifactsOperationCallable() + *
  • importAptArtifactsCallable() + *
+ *
ImportYumArtifacts

Imports Yum (RPM) artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importYumArtifactsAsync(ImportYumArtifactsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importYumArtifactsOperationCallable() + *
  • importYumArtifactsCallable() + *
+ *
ListRepositories

Lists repositories.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listRepositories(ListRepositoriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listRepositories(LocationName parent) + *
  • listRepositories(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listRepositoriesPagedCallable() + *
  • listRepositoriesCallable() + *
+ *
GetRepository

Gets a repository.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getRepository(GetRepositoryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getRepository(RepositoryName name) + *
  • getRepository(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getRepositoryCallable() + *
+ *
CreateRepository

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createRepositoryAsync(CreateRepositoryRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createRepositoryAsync(LocationName parent, Repository repository, String repositoryId) + *
  • createRepositoryAsync(String parent, Repository repository, String repositoryId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createRepositoryOperationCallable() + *
  • createRepositoryCallable() + *
+ *
UpdateRepository

Updates a repository.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateRepository(UpdateRepositoryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateRepository(Repository repository, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateRepositoryCallable() + *
+ *
DeleteRepository

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteRepositoryAsync(DeleteRepositoryRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteRepositoryAsync(RepositoryName name) + *
  • deleteRepositoryAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteRepositoryOperationCallable() + *
  • deleteRepositoryCallable() + *
+ *
ListPackages

Lists packages.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listPackages(ListPackagesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listPackages(RepositoryName parent) + *
  • listPackages(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPackagesPagedCallable() + *
  • listPackagesCallable() + *
+ *
GetPackage

Gets a package.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPackage(GetPackageRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPackage(PackageName name) + *
  • getPackage(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPackageCallable() + *
+ *
DeletePackage

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deletePackageAsync(DeletePackageRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deletePackageAsync(PackageName name) + *
  • deletePackageAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deletePackageOperationCallable() + *
  • deletePackageCallable() + *
+ *
ListVersions

Lists versions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listVersions(ListVersionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listVersions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listVersionsPagedCallable() + *
  • listVersionsCallable() + *
+ *
GetVersion

Gets a version

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getVersion(GetVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getVersion(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getVersionCallable() + *
+ *
DeleteVersion

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteVersionAsync(DeleteVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteVersionOperationCallable() + *
  • deleteVersionCallable() + *
+ *
BatchDeleteVersions

Deletes multiple versions across a repository. The returned operation will complete once the versions have been deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchDeleteVersionsAsync(BatchDeleteVersionsRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchDeleteVersionsAsync(PackageName parent, List names) + *
  • batchDeleteVersionsAsync(String parent, List names) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchDeleteVersionsOperationCallable() + *
  • batchDeleteVersionsCallable() + *
+ *
ListFiles

Lists files.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFiles(ListFilesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFiles(RepositoryName parent) + *
  • listFiles(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFilesPagedCallable() + *
  • listFilesCallable() + *
+ *
GetFile

Gets a file.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFile(GetFileRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFile(FileName name) + *
  • getFile(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFileCallable() + *
+ *
ListTags

Lists tags.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTags(ListTagsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTags(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTagsPagedCallable() + *
  • listTagsCallable() + *
+ *
GetTag

Gets a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTag(GetTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTag(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTagCallable() + *
+ *
CreateTag

Creates a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTag(CreateTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTag(String parent, Tag tag, String tagId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTagCallable() + *
+ *
UpdateTag

Updates a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTag(UpdateTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTag(Tag tag, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTagCallable() + *
+ *
DeleteTag

Deletes a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTag(DeleteTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteTag(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTagCallable() + *
+ *
SetIamPolicy

Updates the IAM policy for a given resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the IAM policy for a given resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Tests if the caller has a list of permissions on a resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
GetProjectSettings

Retrieves the Settings for the Project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getProjectSettings(GetProjectSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getProjectSettings(ProjectSettingsName name) + *
  • getProjectSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getProjectSettingsCallable() + *
+ *
UpdateProjectSettings

Updates the Settings for the Project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateProjectSettings(UpdateProjectSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateProjectSettings(ProjectSettings projectSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateProjectSettingsCallable() + *
+ *
GetVPCSCConfig

Retrieves the VPCSC Config for the Project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getVPCSCConfig(GetVPCSCConfigRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getVPCSCConfig(VpcscConfigName name) + *
  • getVPCSCConfig(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getVPCSCConfigCallable() + *
+ *
UpdateVPCSCConfig

Updates the VPCSC Config for the Project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateVPCSCConfig(UpdateVPCSCConfigRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateVPCSCConfig(VPCSCConfig vpcscConfig, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateVPCSCConfigCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/stub/ArtifactRegistryStubSettings.java b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/stub/ArtifactRegistryStubSettings.java index 1937d7e66f18..12150ee882fb 100644 --- a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/stub/ArtifactRegistryStubSettings.java +++ b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1/stub/ArtifactRegistryStubSettings.java @@ -1087,6 +1087,12 @@ public ArtifactRegistryStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "artifactregistry"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/ArtifactRegistryClient.java b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/ArtifactRegistryClient.java index 040f9a5c4847..0c8e863fad6e 100644 --- a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/ArtifactRegistryClient.java +++ b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/ArtifactRegistryClient.java @@ -84,19 +84,488 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ImportAptArtifacts

Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importAptArtifactsAsync(ImportAptArtifactsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importAptArtifactsOperationCallable() + *
  • importAptArtifactsCallable() + *
+ *
ImportYumArtifacts

Imports Yum (RPM) artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importYumArtifactsAsync(ImportYumArtifactsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importYumArtifactsOperationCallable() + *
  • importYumArtifactsCallable() + *
+ *
ListRepositories

Lists repositories.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listRepositories(ListRepositoriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listRepositories(LocationName parent) + *
  • listRepositories(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listRepositoriesPagedCallable() + *
  • listRepositoriesCallable() + *
+ *
GetRepository

Gets a repository.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getRepository(GetRepositoryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getRepository(RepositoryName name) + *
  • getRepository(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getRepositoryCallable() + *
+ *
CreateRepository

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createRepositoryAsync(CreateRepositoryRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createRepositoryAsync(LocationName parent, Repository repository, String repositoryId) + *
  • createRepositoryAsync(String parent, Repository repository, String repositoryId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createRepositoryOperationCallable() + *
  • createRepositoryCallable() + *
+ *
UpdateRepository

Updates a repository.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateRepository(UpdateRepositoryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateRepository(Repository repository, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateRepositoryCallable() + *
+ *
DeleteRepository

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteRepositoryAsync(DeleteRepositoryRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteRepositoryAsync(RepositoryName name) + *
  • deleteRepositoryAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteRepositoryOperationCallable() + *
  • deleteRepositoryCallable() + *
+ *
ListPackages

Lists packages.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listPackages(ListPackagesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listPackages(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listPackagesPagedCallable() + *
  • listPackagesCallable() + *
+ *
GetPackage

Gets a package.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getPackage(GetPackageRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getPackage(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getPackageCallable() + *
+ *
DeletePackage

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deletePackageAsync(DeletePackageRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deletePackageAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deletePackageOperationCallable() + *
  • deletePackageCallable() + *
+ *
ListVersions

Lists versions.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listVersions(ListVersionsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listVersions(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listVersionsPagedCallable() + *
  • listVersionsCallable() + *
+ *
GetVersion

Gets a version

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getVersion(GetVersionRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getVersion(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getVersionCallable() + *
+ *
DeleteVersion

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteVersionAsync(DeleteVersionRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteVersionAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteVersionOperationCallable() + *
  • deleteVersionCallable() + *
+ *
ListFiles

Lists files.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFiles(ListFilesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFiles(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFilesPagedCallable() + *
  • listFilesCallable() + *
+ *
GetFile

Gets a file.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFile(GetFileRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFile(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFileCallable() + *
+ *
ListTags

Lists tags.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTags(ListTagsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTags(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTagsPagedCallable() + *
  • listTagsCallable() + *
+ *
GetTag

Gets a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTag(GetTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTag(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTagCallable() + *
+ *
CreateTag

Creates a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createTag(CreateTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createTag(String parent, Tag tag, String tagId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createTagCallable() + *
+ *
UpdateTag

Updates a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTag(UpdateTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTag(Tag tag, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTagCallable() + *
+ *
DeleteTag

Deletes a tag.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteTag(DeleteTagRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteTag(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteTagCallable() + *
+ *
SetIamPolicy

Updates the IAM policy for a given resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • setIamPolicy(SetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • setIamPolicyCallable() + *
+ *
GetIamPolicy

Gets the IAM policy for a given resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getIamPolicy(GetIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getIamPolicyCallable() + *
+ *
TestIamPermissions

Tests if the caller has a list of permissions on a resource.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • testIamPermissions(TestIamPermissionsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • testIamPermissionsCallable() + *
+ *
GetProjectSettings

Retrieves the Settings for the Project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getProjectSettings(GetProjectSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getProjectSettings(ProjectSettingsName name) + *
  • getProjectSettings(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getProjectSettingsCallable() + *
+ *
UpdateProjectSettings

Updates the Settings for the Project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateProjectSettings(UpdateProjectSettingsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateProjectSettings(ProjectSettings projectSettings, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateProjectSettingsCallable() + *
+ *
ListLocations

Lists information about the supported locations for this service.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listLocations(ListLocationsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listLocationsPagedCallable() + *
  • listLocationsCallable() + *
+ *
GetLocation

Gets information about a location.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getLocation(GetLocationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getLocationCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/stub/ArtifactRegistryStubSettings.java b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/stub/ArtifactRegistryStubSettings.java index 60c19c2d619b..687f48826703 100644 --- a/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/stub/ArtifactRegistryStubSettings.java +++ b/java-artifact-registry/google-cloud-artifact-registry/src/main/java/com/google/devtools/artifactregistry/v1beta2/stub/ArtifactRegistryStubSettings.java @@ -734,6 +734,12 @@ public ArtifactRegistryStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "artifactregistry"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/AssetServiceClient.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/AssetServiceClient.java index 24107bac35f2..617fc8b1fd40 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/AssetServiceClient.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/AssetServiceClient.java @@ -69,19 +69,435 @@ *

Note: close() needs to be called on the AssetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ExportAssets

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportAssetsAsync(ExportAssetsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportAssetsOperationCallable() + *
  • exportAssetsCallable() + *
+ *
ListAssets

Lists assets with time and resource types and returns paged results in response.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAssets(ListAssetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAssets(ResourceName parent) + *
  • listAssets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAssetsPagedCallable() + *
  • listAssetsCallable() + *
+ *
BatchGetAssetsHistory

Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchGetAssetsHistory(BatchGetAssetsHistoryRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchGetAssetsHistoryCallable() + *
+ *
CreateFeed

Creates a feed in a parent project/folder/organization to listen to its asset updates.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeed(CreateFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createFeed(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeedCallable() + *
+ *
GetFeed

Gets details about an asset feed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeed(GetFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeed(FeedName name) + *
  • getFeed(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeedCallable() + *
+ *
ListFeeds

Lists all asset feeds in a parent project/folder/organization.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeeds(ListFeedsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeeds(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeedsCallable() + *
+ *
UpdateFeed

Updates an asset feed configuration.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeed(UpdateFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateFeed(Feed feed) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeedCallable() + *
+ *
DeleteFeed

Deletes an asset feed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeed(DeleteFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteFeed(FeedName name) + *
  • deleteFeed(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeedCallable() + *
+ *
SearchAllResources

Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchAllResources(SearchAllResourcesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchAllResources(String scope, String query, List assetTypes) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchAllResourcesPagedCallable() + *
  • searchAllResourcesCallable() + *
+ *
SearchAllIamPolicies

Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, otherwise the request will be rejected.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchAllIamPolicies(SearchAllIamPoliciesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchAllIamPolicies(String scope, String query) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchAllIamPoliciesPagedCallable() + *
  • searchAllIamPoliciesCallable() + *
+ *
AnalyzeIamPolicy

Analyzes IAM policies to answer which identities have what accesses on which resources.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • analyzeIamPolicy(AnalyzeIamPolicyRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • analyzeIamPolicyCallable() + *
+ *
AnalyzeIamPolicyLongrunning

Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse]. This method implements the [google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • analyzeIamPolicyLongrunningOperationCallable() + *
  • analyzeIamPolicyLongrunningCallable() + *
+ *
AnalyzeMove

Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • analyzeMove(AnalyzeMoveRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • analyzeMoveCallable() + *
+ *
QueryAssets

Issue a job that queries assets using a SQL statement compatible with [BigQuery SQL](https://cloud.google.com/bigquery/docs/introduction-sql). + *

If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the `QueryAssetsResponse`. + *

Otherwise, full query results can be obtained by issuing extra requests with the `job_reference` from the a previous `QueryAssets` call. + *

Note, the query result has approximately 10 GB limitation enforced by [BigQuery](https://cloud.google.com/bigquery/docs/best-practices-performance-output). Queries return larger results will result in errors.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • queryAssets(QueryAssetsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • queryAssetsCallable() + *
+ *
CreateSavedQuery

Creates a saved query in a parent project/folder/organization.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createSavedQuery(CreateSavedQueryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createSavedQuery(FolderName parent, SavedQuery savedQuery, String savedQueryId) + *
  • createSavedQuery(OrganizationName parent, SavedQuery savedQuery, String savedQueryId) + *
  • createSavedQuery(ProjectName parent, SavedQuery savedQuery, String savedQueryId) + *
  • createSavedQuery(String parent, SavedQuery savedQuery, String savedQueryId) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createSavedQueryCallable() + *
+ *
GetSavedQuery

Gets details about a saved query.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getSavedQuery(GetSavedQueryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getSavedQuery(SavedQueryName name) + *
  • getSavedQuery(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getSavedQueryCallable() + *
+ *
ListSavedQueries

Lists all saved queries in a parent project/folder/organization.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listSavedQueries(ListSavedQueriesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listSavedQueries(FolderName parent) + *
  • listSavedQueries(OrganizationName parent) + *
  • listSavedQueries(ProjectName parent) + *
  • listSavedQueries(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listSavedQueriesPagedCallable() + *
  • listSavedQueriesCallable() + *
+ *
UpdateSavedQuery

Updates a saved query.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateSavedQuery(UpdateSavedQueryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateSavedQuery(SavedQuery savedQuery, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateSavedQueryCallable() + *
+ *
DeleteSavedQuery

Deletes a saved query.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteSavedQuery(DeleteSavedQueryRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteSavedQuery(SavedQueryName name) + *
  • deleteSavedQuery(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteSavedQueryCallable() + *
+ *
BatchGetEffectiveIamPolicies

Gets effective IAM policies for a batch of resources.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchGetEffectiveIamPolicies(BatchGetEffectiveIamPoliciesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchGetEffectiveIamPoliciesCallable() + *
+ *
AnalyzeOrgPolicies

Analyzes organization policies under a scope.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • analyzeOrgPolicies(AnalyzeOrgPoliciesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • analyzeOrgPolicies(String scope, String constraint, String filter) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • analyzeOrgPoliciesPagedCallable() + *
  • analyzeOrgPoliciesCallable() + *
+ *
AnalyzeOrgPolicyGovernedContainers

Analyzes organization policies governed containers (projects, folders or organization) under a scope.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • analyzeOrgPolicyGovernedContainers(AnalyzeOrgPolicyGovernedContainersRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • analyzeOrgPolicyGovernedContainers(String scope, String constraint, String filter) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • analyzeOrgPolicyGovernedContainersPagedCallable() + *
  • analyzeOrgPolicyGovernedContainersCallable() + *
+ *
AnalyzeOrgPolicyGovernedAssets

Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following 10 canned constraints: + *

    + *
  • storage.uniformBucketLevelAccess + *
  • iam.disableServiceAccountKeyCreation + *
  • iam.allowedPolicyMemberDomains + *
  • compute.vmExternalIpAccess + *
  • appengine.enforceServiceAccountActAsCheck + *
  • gcp.resourceLocations + *
  • compute.trustedImageProjects + *
  • compute.skipDefaultNetworkCreation + *
  • compute.requireOsLogin + *
  • compute.disableNestedVirtualization + *
+ *

This RPC only returns either resources of types supported by [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types), or IAM policies.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • analyzeOrgPolicyGovernedAssets(AnalyzeOrgPolicyGovernedAssetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • analyzeOrgPolicyGovernedAssets(String scope, String constraint, String filter) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • analyzeOrgPolicyGovernedAssetsPagedCallable() + *
  • analyzeOrgPolicyGovernedAssetsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/stub/AssetServiceStubSettings.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/stub/AssetServiceStubSettings.java index a335a7fd19e9..c864cbde4156 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/stub/AssetServiceStubSettings.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1/stub/AssetServiceStubSettings.java @@ -852,6 +852,12 @@ public AssetServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "cloudasset"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/AssetServiceClient.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/AssetServiceClient.java index 875d710096f8..3a2d83290c2e 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/AssetServiceClient.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/AssetServiceClient.java @@ -60,19 +60,51 @@ *

Note: close() needs to be called on the AssetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
SearchAllResources

Searches all the resources within a given accessible Resource Manager scope (project/folder/organization). This RPC gives callers especially administrators the ability to search all the resources within a scope, even if they don't have `.get` permission of all the resources. Callers should have `cloud.assets.SearchAllResources` permission on the requested scope, otherwise the request will be rejected.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchAllResources(SearchAllResourcesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchAllResources(String scope, String query, List assetTypes) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchAllResourcesPagedCallable() + *
  • searchAllResourcesCallable() + *
+ *
SearchAllIamPolicies

Searches all the IAM policies within a given accessible Resource Manager scope (project/folder/organization). This RPC gives callers especially administrators the ability to search all the IAM policies within a scope, even if they don't have `.getIamPolicy` permission of all the IAM policies. Callers should have `cloud.assets.SearchAllIamPolicies` permission on the requested scope, otherwise the request will be rejected.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • searchAllIamPolicies(SearchAllIamPoliciesRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • searchAllIamPolicies(String scope, String query) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • searchAllIamPoliciesPagedCallable() + *
  • searchAllIamPoliciesCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/stub/AssetServiceStubSettings.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/stub/AssetServiceStubSettings.java index d27cd452d409..d5c058590778 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/stub/AssetServiceStubSettings.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p1beta1/stub/AssetServiceStubSettings.java @@ -276,6 +276,12 @@ public AssetServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "cloudasset"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/AssetServiceClient.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/AssetServiceClient.java index 03ea30384e8c..2f86767b58bc 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/AssetServiceClient.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/AssetServiceClient.java @@ -48,19 +48,105 @@ *

Note: close() needs to be called on the AssetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateFeed

Creates a feed in a parent project/folder/organization to listen to its asset updates.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createFeed(CreateFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createFeed(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createFeedCallable() + *
+ *
GetFeed

Gets details about an asset feed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getFeed(GetFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getFeed(FeedName name) + *
  • getFeed(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getFeedCallable() + *
+ *
ListFeeds

Lists all asset feeds in a parent project/folder/organization.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listFeeds(ListFeedsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listFeeds(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listFeedsCallable() + *
+ *
UpdateFeed

Updates an asset feed configuration.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateFeed(UpdateFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateFeed(Feed feed) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateFeedCallable() + *
+ *
DeleteFeed

Deletes an asset feed.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteFeed(DeleteFeedRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteFeed(FeedName name) + *
  • deleteFeed(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteFeedCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/stub/AssetServiceStubSettings.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/stub/AssetServiceStubSettings.java index d82f21f1f8ab..d32603fb338b 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/stub/AssetServiceStubSettings.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p2beta1/stub/AssetServiceStubSettings.java @@ -142,6 +142,12 @@ public AssetServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "cloudasset"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/AssetServiceClient.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/AssetServiceClient.java index 2dc811d83255..ca13edf4ff51 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/AssetServiceClient.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/AssetServiceClient.java @@ -76,19 +76,33 @@ *

Note: close() needs to be called on the AssetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ListAssets

Lists assets with time and resource types and returns paged results in response.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listAssets(ListAssetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listAssets(ResourceName parent) + *
  • listAssets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listAssetsPagedCallable() + *
  • listAssetsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/stub/AssetServiceStubSettings.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/stub/AssetServiceStubSettings.java index b058bb543042..1c4d7852018b 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/stub/AssetServiceStubSettings.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p5beta1/stub/AssetServiceStubSettings.java @@ -177,6 +177,12 @@ public AssetServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "cloudasset"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/AssetServiceClient.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/AssetServiceClient.java index 2f6be072c3b8..8aa5d64adb93 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/AssetServiceClient.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/AssetServiceClient.java @@ -59,19 +59,28 @@ *

Note: close() needs to be called on the AssetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
ExportAssets

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1p7beta1.Asset][google.cloud.asset.v1p7beta1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset proto as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API , which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportAssetsAsync(ExportAssetsRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportAssetsOperationCallable() + *
  • exportAssetsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/stub/AssetServiceStubSettings.java b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/stub/AssetServiceStubSettings.java index 652ebce0a734..a445a0655dba 100644 --- a/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/stub/AssetServiceStubSettings.java +++ b/java-asset/google-cloud-asset/src/main/java/com/google/cloud/asset/v1p7beta1/stub/AssetServiceStubSettings.java @@ -118,6 +118,12 @@ public AssetServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "cloudasset"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponse.java b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponse.java index 913eeeb0a3eb..5a2b35df8e19 100644 --- a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponse.java +++ b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponse.java @@ -1,5 +1,5 @@ /* - * Copyright 2024 Google LLC + * Copyright 2023 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponseOrBuilder.java b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponseOrBuilder.java index 4f414d45c0b6..6f8e7eae6382 100644 --- a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponseOrBuilder.java +++ b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/BatchGetAssetsHistoryResponseOrBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2024 Google LLC + * Copyright 2023 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponse.java b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponse.java index 4aeeee796ab9..5effd9dc7565 100644 --- a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponse.java +++ b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponse.java @@ -1,5 +1,5 @@ /* - * Copyright 2024 Google LLC + * Copyright 2023 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponseOrBuilder.java b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponseOrBuilder.java index 5058b3a11c1a..29fab6d63b87 100644 --- a/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponseOrBuilder.java +++ b/java-asset/proto-google-cloud-asset-v1p2beta1/src/main/java/com/google/cloud/asset/v1p2beta1/ExportAssetsResponseOrBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2024 Google LLC + * Copyright 2023 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/java-assured-workloads/README.md b/java-assured-workloads/README.md index 48b76f14a676..91bcefe7cdcd 100644 --- a/java-assured-workloads/README.md +++ b/java-assured-workloads/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-assured-workloads.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-assured-workloads/2.30.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-assured-workloads/2.32.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/AssuredWorkloadsServiceClient.java b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/AssuredWorkloadsServiceClient.java index 0c060e7ffd25..d7d89768c1d6 100644 --- a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/AssuredWorkloadsServiceClient.java +++ b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/AssuredWorkloadsServiceClient.java @@ -64,19 +64,176 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateWorkload

Creates Assured Workload.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createWorkloadAsync(CreateWorkloadRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createWorkloadAsync(LocationName parent, Workload workload) + *
  • createWorkloadAsync(String parent, Workload workload) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createWorkloadOperationCallable() + *
  • createWorkloadCallable() + *
+ *
UpdateWorkload

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateWorkload(UpdateWorkloadRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateWorkload(Workload workload, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateWorkloadCallable() + *
+ *
RestrictAllowedResources

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restrictAllowedResources(RestrictAllowedResourcesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restrictAllowedResourcesCallable() + *
+ *
DeleteWorkload

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteWorkload(DeleteWorkloadRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteWorkload(WorkloadName name) + *
  • deleteWorkload(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteWorkloadCallable() + *
+ *
GetWorkload

Gets Assured Workload associated with a CRM Node

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getWorkload(GetWorkloadRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getWorkload(WorkloadName name) + *
  • getWorkload(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getWorkloadCallable() + *
+ *
ListWorkloads

Lists Assured Workloads under a CRM Node.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listWorkloads(ListWorkloadsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listWorkloads(LocationName parent) + *
  • listWorkloads(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listWorkloadsPagedCallable() + *
  • listWorkloadsCallable() + *
+ *
ListViolations

Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listViolations(ListViolationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listViolations(WorkloadName parent) + *
  • listViolations(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listViolationsPagedCallable() + *
  • listViolationsCallable() + *
+ *
GetViolation

Retrieves Assured Workload Violation based on ID.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getViolation(GetViolationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getViolation(ViolationName name) + *
  • getViolation(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getViolationCallable() + *
+ *
AcknowledgeViolation

Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • acknowledgeViolation(AcknowledgeViolationRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • acknowledgeViolationCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/stub/AssuredWorkloadsServiceStubSettings.java b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/stub/AssuredWorkloadsServiceStubSettings.java index d2384e2ed8bf..1f4743552158 100644 --- a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/stub/AssuredWorkloadsServiceStubSettings.java +++ b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1/stub/AssuredWorkloadsServiceStubSettings.java @@ -319,6 +319,12 @@ public AssuredWorkloadsServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "assuredworkloads"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/AssuredWorkloadsServiceClient.java b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/AssuredWorkloadsServiceClient.java index a171808264b1..1fd6fba98491 100644 --- a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/AssuredWorkloadsServiceClient.java +++ b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/AssuredWorkloadsServiceClient.java @@ -64,19 +64,141 @@ * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateWorkload

Creates Assured Workload.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createWorkloadAsync(CreateWorkloadRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createWorkloadAsync(LocationName parent, Workload workload) + *
  • createWorkloadAsync(String parent, Workload workload) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createWorkloadOperationCallable() + *
  • createWorkloadCallable() + *
+ *
UpdateWorkload

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateWorkload(UpdateWorkloadRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateWorkload(Workload workload, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateWorkloadCallable() + *
+ *
RestrictAllowedResources

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • restrictAllowedResources(RestrictAllowedResourcesRequest request) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • restrictAllowedResourcesCallable() + *
+ *
DeleteWorkload

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteWorkload(DeleteWorkloadRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • deleteWorkload(WorkloadName name) + *
  • deleteWorkload(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteWorkloadCallable() + *
+ *
GetWorkload

Gets Assured Workload associated with a CRM Node

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getWorkload(GetWorkloadRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getWorkload(WorkloadName name) + *
  • getWorkload(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getWorkloadCallable() + *
+ *
AnalyzeWorkloadMove

Analyze if the source Assured Workloads can be moved to the target Assured Workload

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • analyzeWorkloadMove(AnalyzeWorkloadMoveRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • analyzeWorkloadMove(String project, String target) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • analyzeWorkloadMoveCallable() + *
+ *
ListWorkloads

Lists Assured Workloads under a CRM Node.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listWorkloads(ListWorkloadsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listWorkloads(LocationName parent) + *
  • listWorkloads(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listWorkloadsPagedCallable() + *
  • listWorkloadsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/stub/AssuredWorkloadsServiceStubSettings.java b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/stub/AssuredWorkloadsServiceStubSettings.java index 37e12256903c..b86f6edd370b 100644 --- a/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/stub/AssuredWorkloadsServiceStubSettings.java +++ b/java-assured-workloads/google-cloud-assured-workloads/src/main/java/com/google/cloud/assuredworkloads/v1beta1/stub/AssuredWorkloadsServiceStubSettings.java @@ -245,6 +245,12 @@ public AssuredWorkloadsServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "assuredworkloads"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-automl/README.md b/java-automl/README.md index 33f922d54407..3ef8e9a85084 100644 --- a/java-automl/README.md +++ b/java-automl/README.md @@ -206,7 +206,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-automl/2.30.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-automl/2.32.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/AutoMlClient.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/AutoMlClient.java index fff65afd5920..0fd752a60e75 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/AutoMlClient.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/AutoMlClient.java @@ -73,19 +73,374 @@ *

Note: close() needs to be called on the AutoMlClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateDataset

Creates a dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDatasetAsync(CreateDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createDatasetAsync(LocationName parent, Dataset dataset) + *
  • createDatasetAsync(String parent, Dataset dataset) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDatasetOperationCallable() + *
  • createDatasetCallable() + *
+ *
GetDataset

Gets a dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataset(GetDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataset(DatasetName name) + *
  • getDataset(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDatasetCallable() + *
+ *
ListDatasets

Lists datasets in a project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDatasets(ListDatasetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDatasets(LocationName parent) + *
  • listDatasets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDatasetsPagedCallable() + *
  • listDatasetsCallable() + *
+ *
UpdateDataset

Updates a dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataset(UpdateDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataset(Dataset dataset, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDatasetCallable() + *
+ *
DeleteDataset

Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDatasetAsync(DeleteDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDatasetAsync(DatasetName name) + *
  • deleteDatasetAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDatasetOperationCallable() + *
  • deleteDatasetCallable() + *
+ *
ImportData

Imports data into a dataset. For Tables this method can only be called on an empty Dataset. + *

For Tables: + *

    + *
  • A [schema_inference_version][google.cloud.automl.v1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes. + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importDataAsync(ImportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • importDataAsync(DatasetName name, InputConfig inputConfig) + *
  • importDataAsync(String name, InputConfig inputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importDataOperationCallable() + *
  • importDataCallable() + *
+ *
ExportData

Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportDataAsync(ExportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportDataAsync(DatasetName name, OutputConfig outputConfig) + *
  • exportDataAsync(String name, OutputConfig outputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportDataOperationCallable() + *
  • exportDataCallable() + *
+ *
GetAnnotationSpec

Gets an annotation spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAnnotationSpec(GetAnnotationSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAnnotationSpec(AnnotationSpecName name) + *
  • getAnnotationSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAnnotationSpecCallable() + *
+ *
CreateModel

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createModelAsync(CreateModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createModelAsync(LocationName parent, Model model) + *
  • createModelAsync(String parent, Model model) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createModelOperationCallable() + *
  • createModelCallable() + *
+ *
GetModel

Gets a model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModel(GetModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModel(ModelName name) + *
  • getModel(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelCallable() + *
+ *
ListModels

Lists models.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModels(ListModelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModels(LocationName parent) + *
  • listModels(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelsPagedCallable() + *
  • listModelsCallable() + *
+ *
DeleteModel

Deletes a model. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelAsync(DeleteModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelAsync(ModelName name) + *
  • deleteModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelOperationCallable() + *
  • deleteModelCallable() + *
+ *
UpdateModel

Updates a model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateModel(UpdateModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateModel(Model model, FieldMask updateMask) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateModelCallable() + *
+ *
DeployModel

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [node_number][google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability. + *

Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically. + *

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deployModelAsync(DeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deployModelAsync(ModelName name) + *
  • deployModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deployModelOperationCallable() + *
  • deployModelCallable() + *
+ *
UndeployModel

Undeploys a model. If the model is not deployed this method has no effect. + *

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically. + *

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • undeployModelAsync(UndeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • undeployModelAsync(ModelName name) + *
  • undeployModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • undeployModelOperationCallable() + *
  • undeployModelCallable() + *
+ *
ExportModel

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig]. + *

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportModelAsync(ExportModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportModelAsync(ModelName name, ModelExportOutputConfig outputConfig) + *
  • exportModelAsync(String name, ModelExportOutputConfig outputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportModelOperationCallable() + *
  • exportModelCallable() + *
+ *
GetModelEvaluation

Gets a model evaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelEvaluation(GetModelEvaluationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelEvaluation(ModelEvaluationName name) + *
  • getModelEvaluation(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelEvaluationCallable() + *
+ *
ListModelEvaluations

Lists model evaluations.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelEvaluations(ListModelEvaluationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelEvaluations(ModelName parent, String filter) + *
  • listModelEvaluations(String parent, String filter) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelEvaluationsPagedCallable() + *
  • listModelEvaluationsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/PredictionServiceClient.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/PredictionServiceClient.java index 12f10d769afb..1cb163b28ae6 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/PredictionServiceClient.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/PredictionServiceClient.java @@ -58,19 +58,89 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
Predict

Perform an online prediction. The prediction result is directly returned in the response. Available for following ML scenarios, and their expected request payloads: + *

AutoML Vision Classification + *

    + *
  • An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. + *
+ *

AutoML Vision Object Detection + *

    + *
  • An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. + *
+ *

AutoML Natural Language Classification + *

    + *
  • A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB. + *
+ *

AutoML Natural Language Entity Extraction + *

    + *
  • A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document in .PDF, .TIF or .TIFF format with size upto 20MB. + *
+ *

AutoML Natural Language Sentiment Analysis + *

    + *
  • A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB. + *
+ *

AutoML Translation + *

    + *
  • A TextSnippet up to 25,000 characters, UTF-8 encoded. + *
+ *

AutoML Tables + *

    + *
  • A row with column values matching the columns of the model, up to 5MB. Not available for FORECASTING `prediction_type`. + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • predict(PredictRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • predict(ModelName name, ExamplePayload payload, Map params) + *
  • predict(String name, ExamplePayload payload, Map params) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • predictCallable() + *
+ *
BatchPredict

Perform a batch prediction. Unlike the online [Predict][google.cloud.automl.v1.PredictionService.Predict], batch prediction result won't be immediately available in the response. Instead, a long running operation object is returned. User can poll the operation result via [GetOperation][google.longrunning.Operations.GetOperation] method. Once the operation is done, [BatchPredictResult][google.cloud.automl.v1.BatchPredictResult] is returned in the [response][google.longrunning.Operation.response] field. Available for following ML scenarios: + *

    + *
  • AutoML Vision Classification + *
  • AutoML Vision Object Detection + *
  • AutoML Video Intelligence Classification + *
  • AutoML Video Intelligence Object Tracking * AutoML Natural Language Classification + *
  • AutoML Natural Language Entity Extraction + *
  • AutoML Natural Language Sentiment Analysis + *
  • AutoML Tables + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchPredictAsync(BatchPredictRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchPredictAsync(ModelName name, BatchPredictInputConfig inputConfig, BatchPredictOutputConfig outputConfig, Map params) + *
  • batchPredictAsync(String name, BatchPredictInputConfig inputConfig, BatchPredictOutputConfig outputConfig, Map params) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchPredictOperationCallable() + *
  • batchPredictCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/AutoMlStubSettings.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/AutoMlStubSettings.java index 3d202c1a28be..1f838b1a5ac6 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/AutoMlStubSettings.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/AutoMlStubSettings.java @@ -512,6 +512,12 @@ public AutoMlStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "automl"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/PredictionServiceStubSettings.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/PredictionServiceStubSettings.java index 75aec53fb32a..be8e21c8a233 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/PredictionServiceStubSettings.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1/stub/PredictionServiceStubSettings.java @@ -134,6 +134,12 @@ public PredictionServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "automl"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/AutoMlClient.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/AutoMlClient.java index 77b608dd3e5e..0231c737473d 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/AutoMlClient.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/AutoMlClient.java @@ -73,19 +73,494 @@ *

Note: close() needs to be called on the AutoMlClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
CreateDataset

Creates a dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createDataset(CreateDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • createDataset(LocationName parent, Dataset dataset) + *
  • createDataset(String parent, Dataset dataset) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createDatasetCallable() + *
+ *
GetDataset

Gets a dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getDataset(GetDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getDataset(DatasetName name) + *
  • getDataset(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getDatasetCallable() + *
+ *
ListDatasets

Lists datasets in a project.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listDatasets(ListDatasetsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listDatasets(LocationName parent) + *
  • listDatasets(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listDatasetsPagedCallable() + *
  • listDatasetsCallable() + *
+ *
UpdateDataset

Updates a dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateDataset(UpdateDatasetRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateDataset(Dataset dataset) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateDatasetCallable() + *
+ *
DeleteDataset

Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteDatasetAsync(DeleteDatasetRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteDatasetAsync(DatasetName name) + *
  • deleteDatasetAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteDatasetOperationCallable() + *
  • deleteDatasetCallable() + *
+ *
ImportData

Imports data into a dataset. For Tables this method can only be called on an empty Dataset. + *

For Tables: + *

    + *
  • A [schema_inference_version][google.cloud.automl.v1beta1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes. + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • importDataAsync(ImportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • importDataAsync(DatasetName name, InputConfig inputConfig) + *
  • importDataAsync(String name, InputConfig inputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • importDataOperationCallable() + *
  • importDataCallable() + *
+ *
ExportData

Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportDataAsync(ExportDataRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportDataAsync(DatasetName name, OutputConfig outputConfig) + *
  • exportDataAsync(String name, OutputConfig outputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportDataOperationCallable() + *
  • exportDataCallable() + *
+ *
GetAnnotationSpec

Gets an annotation spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getAnnotationSpec(GetAnnotationSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getAnnotationSpec(AnnotationSpecName name) + *
  • getAnnotationSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getAnnotationSpecCallable() + *
+ *
GetTableSpec

Gets a table spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getTableSpec(GetTableSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getTableSpec(TableSpecName name) + *
  • getTableSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getTableSpecCallable() + *
+ *
ListTableSpecs

Lists table specs in a dataset.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listTableSpecs(ListTableSpecsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listTableSpecs(DatasetName parent) + *
  • listTableSpecs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listTableSpecsPagedCallable() + *
  • listTableSpecsCallable() + *
+ *
UpdateTableSpec

Updates a table spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateTableSpec(UpdateTableSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateTableSpec(TableSpec tableSpec) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateTableSpecCallable() + *
+ *
GetColumnSpec

Gets a column spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getColumnSpec(GetColumnSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getColumnSpec(ColumnSpecName name) + *
  • getColumnSpec(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getColumnSpecCallable() + *
+ *
ListColumnSpecs

Lists column specs in a table spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listColumnSpecs(ListColumnSpecsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listColumnSpecs(TableSpecName parent) + *
  • listColumnSpecs(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listColumnSpecsPagedCallable() + *
  • listColumnSpecsCallable() + *
+ *
UpdateColumnSpec

Updates a column spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • updateColumnSpec(UpdateColumnSpecRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • updateColumnSpec(ColumnSpec columnSpec) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • updateColumnSpecCallable() + *
+ *
CreateModel

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • createModelAsync(CreateModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • createModelAsync(LocationName parent, Model model) + *
  • createModelAsync(String parent, Model model) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • createModelOperationCallable() + *
  • createModelCallable() + *
+ *
GetModel

Gets a model.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModel(GetModelRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModel(ModelName name) + *
  • getModel(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelCallable() + *
+ *
ListModels

Lists models.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModels(ListModelsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModels(LocationName parent) + *
  • listModels(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelsPagedCallable() + *
  • listModelsCallable() + *
+ *
DeleteModel

Deletes a model. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deleteModelAsync(DeleteModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deleteModelAsync(ModelName name) + *
  • deleteModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deleteModelOperationCallable() + *
  • deleteModelCallable() + *
+ *
DeployModel

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing + *

[node_number][google.cloud.automl.v1beta1.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability. + *

Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically. + *

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • deployModelAsync(DeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • deployModelAsync(ModelName name) + *
  • deployModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • deployModelOperationCallable() + *
  • deployModelCallable() + *
+ *
UndeployModel

Undeploys a model. If the model is not deployed this method has no effect. + *

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically. + *

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • undeployModelAsync(UndeployModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • undeployModelAsync(ModelName name) + *
  • undeployModelAsync(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • undeployModelOperationCallable() + *
  • undeployModelCallable() + *
+ *
ExportModel

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in + *

[ModelExportOutputConfig][google.cloud.automl.v1beta1.ModelExportOutputConfig]. + *

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportModelAsync(ExportModelRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportModelAsync(ModelName name, ModelExportOutputConfig outputConfig) + *
  • exportModelAsync(String name, ModelExportOutputConfig outputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportModelOperationCallable() + *
  • exportModelCallable() + *
+ *
ExportEvaluatedExamples

Exports examples on which the model was evaluated (i.e. which were in the TEST set of the dataset the model was created from), together with their ground truth annotations and the annotations created (predicted) by the model. The examples, ground truth and predictions are exported in the state they were at the moment the model was evaluated. + *

This export is available only for 30 days since the model evaluation is created. + *

Currently only available for Tables. + *

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • exportEvaluatedExamplesAsync(ExportEvaluatedExamplesRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • exportEvaluatedExamplesAsync(ModelName name, ExportEvaluatedExamplesOutputConfig outputConfig) + *
  • exportEvaluatedExamplesAsync(String name, ExportEvaluatedExamplesOutputConfig outputConfig) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • exportEvaluatedExamplesOperationCallable() + *
  • exportEvaluatedExamplesCallable() + *
+ *
GetModelEvaluation

Gets a model evaluation.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • getModelEvaluation(GetModelEvaluationRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • getModelEvaluation(ModelEvaluationName name) + *
  • getModelEvaluation(String name) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • getModelEvaluationCallable() + *
+ *
ListModelEvaluations

Lists model evaluations.

 + *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • listModelEvaluations(ListModelEvaluationsRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • listModelEvaluations(ModelName parent) + *
  • listModelEvaluations(String parent) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • listModelEvaluationsPagedCallable() + *
  • listModelEvaluationsCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/PredictionServiceClient.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/PredictionServiceClient.java index 7c495d2d31c7..3ed35435e5ae 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/PredictionServiceClient.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/PredictionServiceClient.java @@ -58,19 +58,71 @@ * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). * - *

The surface of this class includes several types of Java methods for each of the API's - * methods: - * - *

    - *
  1. A "flattened" method. With this type of method, the fields of the request type have been - * converted into function parameters. It may be the case that not all fields are available as - * parameters, and not every API method will have a flattened method entry point. - *
  2. A "request object" method. This type of method only takes one parameter, a request object, - * which must be constructed before the call. Not every API method will have a request object - * method. - *
  3. A "callable" method. This type of method takes no parameters and returns an immutable API - * callable object, which can be used to initiate calls to the service. - *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
MethodDescriptionMethod Variants
Predict

Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads: + *

    + *
  • Image Classification - Image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. + *
  • Image Object Detection - Image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. + *
  • Text Classification - TextSnippet, content up to 60,000 characters, UTF-8 encoded. + *
  • Text Extraction - TextSnippet, content up to 30,000 characters, UTF-8 NFC encoded. + *
  • Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded. + *
  • Tables - Row, with column values matching the columns of the model, up to 5MB. Not available for FORECASTING + *
+ *

[prediction_type][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]. + *

    + *
  • Text Sentiment - TextSnippet, content up 500 characters, UTF-8 encoded. + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • predict(PredictRequest request) + *
+ *

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

+ *
    + *
  • predict(ModelName name, ExamplePayload payload, Map params) + *
  • predict(String name, ExamplePayload payload, Map params) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • predictCallable() + *
+ *
BatchPredict

Perform a batch prediction. Unlike the online [Predict][google.cloud.automl.v1beta1.PredictionService.Predict], batch prediction result won't be immediately available in the response. Instead, a long running operation object is returned. User can poll the operation result via [GetOperation][google.longrunning.Operations.GetOperation] method. Once the operation is done, [BatchPredictResult][google.cloud.automl.v1beta1.BatchPredictResult] is returned in the [response][google.longrunning.Operation.response] field. Available for following ML problems: + *

    + *
  • Image Classification + *
  • Image Object Detection + *
  • Video Classification + *
  • Video Object Tracking * Text Extraction + *
  • Tables + *
+ *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

+ *
    + *
  • batchPredictAsync(BatchPredictRequest request) + *
+ *

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

+ *
    + *
  • batchPredictAsync(ModelName name, BatchPredictInputConfig inputConfig, BatchPredictOutputConfig outputConfig, Map params) + *
  • batchPredictAsync(String name, BatchPredictInputConfig inputConfig, BatchPredictOutputConfig outputConfig, Map params) + *
+ *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

+ *
    + *
  • batchPredictOperationCallable() + *
  • batchPredictCallable() + *
+ *
* *

See the individual methods for example code. * diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/AutoMlStubSettings.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/AutoMlStubSettings.java index c443d923e53e..ce1ae91284e9 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/AutoMlStubSettings.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/AutoMlStubSettings.java @@ -681,6 +681,12 @@ public AutoMlStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "automl"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); diff --git a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/PredictionServiceStubSettings.java b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/PredictionServiceStubSettings.java index 9a208e3b8f51..336f87b43382 100644 --- a/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/PredictionServiceStubSettings.java +++ b/java-automl/google-cloud-automl/src/main/java/com/google/cloud/automl/v1beta1/stub/PredictionServiceStubSettings.java @@ -135,6 +135,12 @@ public PredictionServiceStub createStub() throws IOException { "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } + /** Returns the default service name. */ + @Override + public String getServiceName() { + return "automl"; + } + /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder();