- 0.48.0 (latest)
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.1
- 0.2.2
- 0.1.1
public class RegistryClient implements BackgroundResource
Service Description: The Registry service allows teams to manage descriptions of APIs.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName name = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
Api response = registryClient.getApi(name);
}
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:
- 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.
- 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.
- 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.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of RegistrySettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
RegistrySettings registrySettings =
RegistrySettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RegistryClient registryClient = RegistryClient.create(registrySettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
RegistrySettings registrySettings =
RegistrySettings.newBuilder().setEndpoint(myEndpoint).build();
RegistryClient registryClient = RegistryClient.create(registrySettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
RegistrySettings registrySettings = RegistrySettings.newHttpJsonBuilder().build();
RegistryClient registryClient = RegistryClient.create(registrySettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final RegistryClient create()
Constructs an instance of RegistryClient with default settings.
Returns | |
---|---|
Type | Description |
RegistryClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(RegistrySettings settings)
public static final RegistryClient create(RegistrySettings settings)
Constructs an instance of RegistryClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings | RegistrySettings |
Returns | |
---|---|
Type | Description |
RegistryClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(RegistryStub stub)
public static final RegistryClient create(RegistryStub stub)
Constructs an instance of RegistryClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegistrySettings).
Parameter | |
---|---|
Name | Description |
stub | RegistryStub |
Returns | |
---|---|
Type | Description |
RegistryClient |
Constructors
RegistryClient(RegistrySettings settings)
protected RegistryClient(RegistrySettings settings)
Constructs an instance of RegistryClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings | RegistrySettings |
RegistryClient(RegistryStub stub)
protected RegistryClient(RegistryStub stub)
Parameter | |
---|---|
Name | Description |
stub | RegistryStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createApi(CreateApiRequest request)
public final Api createApi(CreateApiRequest request)
Creates a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiRequest request =
CreateApiRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setApi(Api.newBuilder().build())
.setApiId("apiId93021397")
.build();
Api response = registryClient.createApi(request);
}
Parameter | |
---|---|
Name | Description |
request | CreateApiRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Api |
createApi(LocationName parent, Api api, String apiId)
public final Api createApi(LocationName parent, Api api, String apiId)
Creates a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Api api = Api.newBuilder().build();
String apiId = "apiId93021397";
Api response = registryClient.createApi(parent, api, apiId);
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent, which owns this collection of APIs. Format:
|
api | Api Required. The API to create. |
apiId | String Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Api |
createApi(String parent, Api api, String apiId)
public final Api createApi(String parent, Api api, String apiId)
Creates a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Api api = Api.newBuilder().build();
String apiId = "apiId93021397";
Api response = registryClient.createApi(parent, api, apiId);
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of APIs. Format:
|
api | Api Required. The API to create. |
apiId | String Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Api |
createApiCallable()
public final UnaryCallable<CreateApiRequest,Api> createApiCallable()
Creates a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiRequest request =
CreateApiRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setApi(Api.newBuilder().build())
.setApiId("apiId93021397")
.build();
ApiFuture<Api> future = registryClient.createApiCallable().futureCall(request);
// Do something.
Api response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateApiRequest,Api> |
createApiDeployment(ApiName parent, ApiDeployment apiDeployment, String apiDeploymentId)
public final ApiDeployment createApiDeployment(ApiName parent, ApiDeployment apiDeployment, String apiDeploymentId)
Creates a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
ApiDeployment apiDeployment = ApiDeployment.newBuilder().build();
String apiDeploymentId = "apiDeploymentId-1299472902";
ApiDeployment response =
registryClient.createApiDeployment(parent, apiDeployment, apiDeploymentId);
}
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. The parent, which owns this collection of deployments. Format:
|
apiDeployment | ApiDeployment Required. The deployment to create. |
apiDeploymentId | String Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
createApiDeployment(CreateApiDeploymentRequest request)
public final ApiDeployment createApiDeployment(CreateApiDeploymentRequest request)
Creates a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiDeploymentRequest request =
CreateApiDeploymentRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setApiDeployment(ApiDeployment.newBuilder().build())
.setApiDeploymentId("apiDeploymentId-1299472902")
.build();
ApiDeployment response = registryClient.createApiDeployment(request);
}
Parameter | |
---|---|
Name | Description |
request | CreateApiDeploymentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
createApiDeployment(String parent, ApiDeployment apiDeployment, String apiDeploymentId)
public final ApiDeployment createApiDeployment(String parent, ApiDeployment apiDeployment, String apiDeploymentId)
Creates a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString();
ApiDeployment apiDeployment = ApiDeployment.newBuilder().build();
String apiDeploymentId = "apiDeploymentId-1299472902";
ApiDeployment response =
registryClient.createApiDeployment(parent, apiDeployment, apiDeploymentId);
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of deployments. Format:
|
apiDeployment | ApiDeployment Required. The deployment to create. |
apiDeploymentId | String Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
createApiDeploymentCallable()
public final UnaryCallable<CreateApiDeploymentRequest,ApiDeployment> createApiDeploymentCallable()
Creates a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiDeploymentRequest request =
CreateApiDeploymentRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setApiDeployment(ApiDeployment.newBuilder().build())
.setApiDeploymentId("apiDeploymentId-1299472902")
.build();
ApiFuture<ApiDeployment> future =
registryClient.createApiDeploymentCallable().futureCall(request);
// Do something.
ApiDeployment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateApiDeploymentRequest,ApiDeployment> |
createApiSpec(ApiVersionName parent, ApiSpec apiSpec, String apiSpecId)
public final ApiSpec createApiSpec(ApiVersionName parent, ApiSpec apiSpec, String apiSpecId)
Creates a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiVersionName parent = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
ApiSpec apiSpec = ApiSpec.newBuilder().build();
String apiSpecId = "apiSpecId-421795600";
ApiSpec response = registryClient.createApiSpec(parent, apiSpec, apiSpecId);
}
Parameters | |
---|---|
Name | Description |
parent | ApiVersionName Required. The parent, which owns this collection of specs. Format:
|
apiSpec | ApiSpec Required. The spec to create. |
apiSpecId | String Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
ApiSpec |
createApiSpec(CreateApiSpecRequest request)
public final ApiSpec createApiSpec(CreateApiSpecRequest request)
Creates a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiSpecRequest request =
CreateApiSpecRequest.newBuilder()
.setParent(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.setApiSpec(ApiSpec.newBuilder().build())
.setApiSpecId("apiSpecId-421795600")
.build();
ApiSpec response = registryClient.createApiSpec(request);
}
Parameter | |
---|---|
Name | Description |
request | CreateApiSpecRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiSpec |
createApiSpec(String parent, ApiSpec apiSpec, String apiSpecId)
public final ApiSpec createApiSpec(String parent, ApiSpec apiSpec, String apiSpecId)
Creates a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString();
ApiSpec apiSpec = ApiSpec.newBuilder().build();
String apiSpecId = "apiSpecId-421795600";
ApiSpec response = registryClient.createApiSpec(parent, apiSpec, apiSpecId);
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of specs. Format:
|
apiSpec | ApiSpec Required. The spec to create. |
apiSpecId | String Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
ApiSpec |
createApiSpecCallable()
public final UnaryCallable<CreateApiSpecRequest,ApiSpec> createApiSpecCallable()
Creates a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiSpecRequest request =
CreateApiSpecRequest.newBuilder()
.setParent(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.setApiSpec(ApiSpec.newBuilder().build())
.setApiSpecId("apiSpecId-421795600")
.build();
ApiFuture<ApiSpec> future = registryClient.createApiSpecCallable().futureCall(request);
// Do something.
ApiSpec response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateApiSpecRequest,ApiSpec> |
createApiVersion(ApiName parent, ApiVersion apiVersion, String apiVersionId)
public final ApiVersion createApiVersion(ApiName parent, ApiVersion apiVersion, String apiVersionId)
Creates a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
ApiVersion apiVersion = ApiVersion.newBuilder().build();
String apiVersionId = "apiVersionId1678816025";
ApiVersion response = registryClient.createApiVersion(parent, apiVersion, apiVersionId);
}
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. The parent, which owns this collection of versions. Format:
|
apiVersion | ApiVersion Required. The version to create. |
apiVersionId | String Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
ApiVersion |
createApiVersion(CreateApiVersionRequest request)
public final ApiVersion createApiVersion(CreateApiVersionRequest request)
Creates a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiVersionRequest request =
CreateApiVersionRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setApiVersion(ApiVersion.newBuilder().build())
.setApiVersionId("apiVersionId1678816025")
.build();
ApiVersion response = registryClient.createApiVersion(request);
}
Parameter | |
---|---|
Name | Description |
request | CreateApiVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiVersion |
createApiVersion(String parent, ApiVersion apiVersion, String apiVersionId)
public final ApiVersion createApiVersion(String parent, ApiVersion apiVersion, String apiVersionId)
Creates a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString();
ApiVersion apiVersion = ApiVersion.newBuilder().build();
String apiVersionId = "apiVersionId1678816025";
ApiVersion response = registryClient.createApiVersion(parent, apiVersion, apiVersionId);
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of versions. Format:
|
apiVersion | ApiVersion Required. The version to create. |
apiVersionId | String Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
ApiVersion |
createApiVersionCallable()
public final UnaryCallable<CreateApiVersionRequest,ApiVersion> createApiVersionCallable()
Creates a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateApiVersionRequest request =
CreateApiVersionRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setApiVersion(ApiVersion.newBuilder().build())
.setApiVersionId("apiVersionId1678816025")
.build();
ApiFuture<ApiVersion> future = registryClient.createApiVersionCallable().futureCall(request);
// Do something.
ApiVersion response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateApiVersionRequest,ApiVersion> |
createArtifact(ApiDeploymentName parent, Artifact artifact, String artifactId)
public final Artifact createArtifact(ApiDeploymentName parent, Artifact artifact, String artifactId)
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiDeploymentName parent =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]");
Artifact artifact = Artifact.newBuilder().build();
String artifactId = "artifactId240640653";
Artifact response = registryClient.createArtifact(parent, artifact, artifactId);
}
Parameters | |
---|---|
Name | Description |
parent | ApiDeploymentName Required. The parent, which owns this collection of artifacts. Format: |
artifact | Artifact Required. The artifact to create. |
artifactId | String Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Artifact |
createArtifact(ApiName parent, Artifact artifact, String artifactId)
public final Artifact createArtifact(ApiName parent, Artifact artifact, String artifactId)
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
Artifact artifact = Artifact.newBuilder().build();
String artifactId = "artifactId240640653";
Artifact response = registryClient.createArtifact(parent, artifact, artifactId);
}
Parameters | |
---|---|
Name | Description |
parent | ApiName Required. The parent, which owns this collection of artifacts. Format: |
artifact | Artifact Required. The artifact to create. |
artifactId | String Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Artifact |
createArtifact(ApiSpecName parent, Artifact artifact, String artifactId)
public final Artifact createArtifact(ApiSpecName parent, Artifact artifact, String artifactId)
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiSpecName parent =
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
Artifact artifact = Artifact.newBuilder().build();
String artifactId = "artifactId240640653";
Artifact response = registryClient.createArtifact(parent, artifact, artifactId);
}
Parameters | |
---|---|
Name | Description |
parent | ApiSpecName Required. The parent, which owns this collection of artifacts. Format: |
artifact | Artifact Required. The artifact to create. |
artifactId | String Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Artifact |
createArtifact(ApiVersionName parent, Artifact artifact, String artifactId)
public final Artifact createArtifact(ApiVersionName parent, Artifact artifact, String artifactId)
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiVersionName parent = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
Artifact artifact = Artifact.newBuilder().build();
String artifactId = "artifactId240640653";
Artifact response = registryClient.createArtifact(parent, artifact, artifactId);
}
Parameters | |
---|---|
Name | Description |
parent | ApiVersionName Required. The parent, which owns this collection of artifacts. Format: |
artifact | Artifact Required. The artifact to create. |
artifactId | String Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Artifact |
createArtifact(CreateArtifactRequest request)
public final Artifact createArtifact(CreateArtifactRequest request)
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateArtifactRequest request =
CreateArtifactRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setArtifact(Artifact.newBuilder().build())
.setArtifactId("artifactId240640653")
.build();
Artifact response = registryClient.createArtifact(request);
}
Parameter | |
---|---|
Name | Description |
request | CreateArtifactRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Artifact |
createArtifact(LocationName parent, Artifact artifact, String artifactId)
public final Artifact createArtifact(LocationName parent, Artifact artifact, String artifactId)
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Artifact artifact = Artifact.newBuilder().build();
String artifactId = "artifactId240640653";
Artifact response = registryClient.createArtifact(parent, artifact, artifactId);
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent, which owns this collection of artifacts. Format: |
artifact | Artifact Required. The artifact to create. |
artifactId | String Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Artifact |
createArtifact(String parent, Artifact artifact, String artifactId)
public final Artifact createArtifact(String parent, Artifact artifact, String artifactId)
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Artifact artifact = Artifact.newBuilder().build();
String artifactId = "artifactId240640653";
Artifact response = registryClient.createArtifact(parent, artifact, artifactId);
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of artifacts. Format: |
artifact | Artifact Required. The artifact to create. |
artifactId | String Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
Returns | |
---|---|
Type | Description |
Artifact |
createArtifactCallable()
public final UnaryCallable<CreateArtifactRequest,Artifact> createArtifactCallable()
Creates a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
CreateArtifactRequest request =
CreateArtifactRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setArtifact(Artifact.newBuilder().build())
.setArtifactId("artifactId240640653")
.build();
ApiFuture<Artifact> future = registryClient.createArtifactCallable().futureCall(request);
// Do something.
Artifact response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateArtifactRequest,Artifact> |
deleteApi(ApiName name)
public final void deleteApi(ApiName name)
Removes a specified API and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName name = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
registryClient.deleteApi(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiName Required. The name of the API to delete. Format:
|
deleteApi(DeleteApiRequest request)
public final void deleteApi(DeleteApiRequest request)
Removes a specified API and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiRequest request =
DeleteApiRequest.newBuilder()
.setName(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setForce(true)
.build();
registryClient.deleteApi(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteApiRequest The request object containing all of the parameters for the API call. |
deleteApi(String name)
public final void deleteApi(String name)
Removes a specified API and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name = ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString();
registryClient.deleteApi(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the API to delete. Format:
|
deleteApiCallable()
public final UnaryCallable<DeleteApiRequest,Empty> deleteApiCallable()
Removes a specified API and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiRequest request =
DeleteApiRequest.newBuilder()
.setName(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setForce(true)
.build();
ApiFuture<Empty> future = registryClient.deleteApiCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteApiRequest,Empty> |
deleteApiDeployment(ApiDeploymentName name)
public final void deleteApiDeployment(ApiDeploymentName name)
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiDeploymentName name =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]");
registryClient.deleteApiDeployment(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiDeploymentName Required. The name of the deployment to delete. Format:
|
deleteApiDeployment(DeleteApiDeploymentRequest request)
public final void deleteApiDeployment(DeleteApiDeploymentRequest request)
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiDeploymentRequest request =
DeleteApiDeploymentRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setForce(true)
.build();
registryClient.deleteApiDeployment(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteApiDeploymentRequest The request object containing all of the parameters for the API call. |
deleteApiDeployment(String name)
public final void deleteApiDeployment(String name)
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]").toString();
registryClient.deleteApiDeployment(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the deployment to delete. Format:
|
deleteApiDeploymentCallable()
public final UnaryCallable<DeleteApiDeploymentRequest,Empty> deleteApiDeploymentCallable()
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiDeploymentRequest request =
DeleteApiDeploymentRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setForce(true)
.build();
ApiFuture<Empty> future = registryClient.deleteApiDeploymentCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteApiDeploymentRequest,Empty> |
deleteApiDeploymentRevision(ApiDeploymentName name)
public final ApiDeployment deleteApiDeploymentRevision(ApiDeploymentName name)
Deletes a revision of a deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiDeploymentName name =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]");
ApiDeployment response = registryClient.deleteApiDeploymentRevision(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiDeploymentName Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example:
|
Returns | |
---|---|
Type | Description |
ApiDeployment |
deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request)
public final ApiDeployment deleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest request)
Deletes a revision of a deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiDeploymentRevisionRequest request =
DeleteApiDeploymentRevisionRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.build();
ApiDeployment response = registryClient.deleteApiDeploymentRevision(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteApiDeploymentRevisionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
deleteApiDeploymentRevision(String name)
public final ApiDeployment deleteApiDeploymentRevision(String name)
Deletes a revision of a deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]").toString();
ApiDeployment response = registryClient.deleteApiDeploymentRevision(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example:
|
Returns | |
---|---|
Type | Description |
ApiDeployment |
deleteApiDeploymentRevisionCallable()
public final UnaryCallable<DeleteApiDeploymentRevisionRequest,ApiDeployment> deleteApiDeploymentRevisionCallable()
Deletes a revision of a deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiDeploymentRevisionRequest request =
DeleteApiDeploymentRevisionRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.build();
ApiFuture<ApiDeployment> future =
registryClient.deleteApiDeploymentRevisionCallable().futureCall(request);
// Do something.
ApiDeployment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteApiDeploymentRevisionRequest,ApiDeployment> |
deleteApiSpec(ApiSpecName name)
public final void deleteApiSpec(ApiSpecName name)
Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiSpecName name = ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
registryClient.deleteApiSpec(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiSpecName Required. The name of the spec to delete. Format:
|
deleteApiSpec(DeleteApiSpecRequest request)
public final void deleteApiSpec(DeleteApiSpecRequest request)
Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiSpecRequest request =
DeleteApiSpecRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setForce(true)
.build();
registryClient.deleteApiSpec(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteApiSpecRequest The request object containing all of the parameters for the API call. |
deleteApiSpec(String name)
public final void deleteApiSpec(String name)
Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]").toString();
registryClient.deleteApiSpec(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the spec to delete. Format:
|
deleteApiSpecCallable()
public final UnaryCallable<DeleteApiSpecRequest,Empty> deleteApiSpecCallable()
Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiSpecRequest request =
DeleteApiSpecRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setForce(true)
.build();
ApiFuture<Empty> future = registryClient.deleteApiSpecCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteApiSpecRequest,Empty> |
deleteApiSpecRevision(ApiSpecName name)
public final ApiSpec deleteApiSpecRevision(ApiSpecName name)
Deletes a revision of a spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiSpecName name = ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
ApiSpec response = registryClient.deleteApiSpecRevision(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiSpecName Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example:
|
Returns | |
---|---|
Type | Description |
ApiSpec |
deleteApiSpecRevision(DeleteApiSpecRevisionRequest request)
public final ApiSpec deleteApiSpecRevision(DeleteApiSpecRevisionRequest request)
Deletes a revision of a spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiSpecRevisionRequest request =
DeleteApiSpecRevisionRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.build();
ApiSpec response = registryClient.deleteApiSpecRevision(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteApiSpecRevisionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiSpec |
deleteApiSpecRevision(String name)
public final ApiSpec deleteApiSpecRevision(String name)
Deletes a revision of a spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]").toString();
ApiSpec response = registryClient.deleteApiSpecRevision(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example:
|
Returns | |
---|---|
Type | Description |
ApiSpec |
deleteApiSpecRevisionCallable()
public final UnaryCallable<DeleteApiSpecRevisionRequest,ApiSpec> deleteApiSpecRevisionCallable()
Deletes a revision of a spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiSpecRevisionRequest request =
DeleteApiSpecRevisionRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.build();
ApiFuture<ApiSpec> future =
registryClient.deleteApiSpecRevisionCallable().futureCall(request);
// Do something.
ApiSpec response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteApiSpecRevisionRequest,ApiSpec> |
deleteApiVersion(ApiVersionName name)
public final void deleteApiVersion(ApiVersionName name)
Removes a specified version and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiVersionName name = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
registryClient.deleteApiVersion(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiVersionName Required. The name of the version to delete. Format:
|
deleteApiVersion(DeleteApiVersionRequest request)
public final void deleteApiVersion(DeleteApiVersionRequest request)
Removes a specified version and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiVersionRequest request =
DeleteApiVersionRequest.newBuilder()
.setName(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.setForce(true)
.build();
registryClient.deleteApiVersion(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteApiVersionRequest The request object containing all of the parameters for the API call. |
deleteApiVersion(String name)
public final void deleteApiVersion(String name)
Removes a specified version and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString();
registryClient.deleteApiVersion(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the version to delete. Format:
|
deleteApiVersionCallable()
public final UnaryCallable<DeleteApiVersionRequest,Empty> deleteApiVersionCallable()
Removes a specified version and all of the resources that it owns.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteApiVersionRequest request =
DeleteApiVersionRequest.newBuilder()
.setName(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.setForce(true)
.build();
ApiFuture<Empty> future = registryClient.deleteApiVersionCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteApiVersionRequest,Empty> |
deleteArtifact(ArtifactName name)
public final void deleteArtifact(ArtifactName name)
Removes a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ArtifactName name =
ArtifactName.ofProjectLocationArtifactName("[PROJECT]", "[LOCATION]", "[ARTIFACT]");
registryClient.deleteArtifact(name);
}
Parameter | |
---|---|
Name | Description |
name | ArtifactName Required. The name of the artifact to delete. Format: |
deleteArtifact(DeleteArtifactRequest request)
public final void deleteArtifact(DeleteArtifactRequest request)
Removes a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteArtifactRequest request =
DeleteArtifactRequest.newBuilder()
.setName(
ArtifactName.ofProjectLocationArtifactName(
"[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString())
.build();
registryClient.deleteArtifact(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteArtifactRequest The request object containing all of the parameters for the API call. |
deleteArtifact(String name)
public final void deleteArtifact(String name)
Removes a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ArtifactName.ofProjectLocationArtifactName("[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString();
registryClient.deleteArtifact(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the artifact to delete. Format: |
deleteArtifactCallable()
public final UnaryCallable<DeleteArtifactRequest,Empty> deleteArtifactCallable()
Removes a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
DeleteArtifactRequest request =
DeleteArtifactRequest.newBuilder()
.setName(
ArtifactName.ofProjectLocationArtifactName(
"[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString())
.build();
ApiFuture<Empty> future = registryClient.deleteArtifactCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteArtifactRequest,Empty> |
getApi(ApiName name)
public final Api getApi(ApiName name)
Returns a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName name = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
Api response = registryClient.getApi(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiName Required. The name of the API to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
Api |
getApi(GetApiRequest request)
public final Api getApi(GetApiRequest request)
Returns a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiRequest request =
GetApiRequest.newBuilder()
.setName(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.build();
Api response = registryClient.getApi(request);
}
Parameter | |
---|---|
Name | Description |
request | GetApiRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Api |
getApi(String name)
public final Api getApi(String name)
Returns a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name = ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString();
Api response = registryClient.getApi(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the API to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
Api |
getApiCallable()
public final UnaryCallable<GetApiRequest,Api> getApiCallable()
Returns a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiRequest request =
GetApiRequest.newBuilder()
.setName(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.build();
ApiFuture<Api> future = registryClient.getApiCallable().futureCall(request);
// Do something.
Api response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetApiRequest,Api> |
getApiDeployment(ApiDeploymentName name)
public final ApiDeployment getApiDeployment(ApiDeploymentName name)
Returns a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiDeploymentName name =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]");
ApiDeployment response = registryClient.getApiDeployment(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiDeploymentName Required. The name of the deployment to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
ApiDeployment |
getApiDeployment(GetApiDeploymentRequest request)
public final ApiDeployment getApiDeployment(GetApiDeploymentRequest request)
Returns a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiDeploymentRequest request =
GetApiDeploymentRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.build();
ApiDeployment response = registryClient.getApiDeployment(request);
}
Parameter | |
---|---|
Name | Description |
request | GetApiDeploymentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
getApiDeployment(String name)
public final ApiDeployment getApiDeployment(String name)
Returns a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]").toString();
ApiDeployment response = registryClient.getApiDeployment(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the deployment to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
ApiDeployment |
getApiDeploymentCallable()
public final UnaryCallable<GetApiDeploymentRequest,ApiDeployment> getApiDeploymentCallable()
Returns a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiDeploymentRequest request =
GetApiDeploymentRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.build();
ApiFuture<ApiDeployment> future =
registryClient.getApiDeploymentCallable().futureCall(request);
// Do something.
ApiDeployment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetApiDeploymentRequest,ApiDeployment> |
getApiSpec(ApiSpecName name)
public final ApiSpec getApiSpec(ApiSpecName name)
Returns a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiSpecName name = ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
ApiSpec response = registryClient.getApiSpec(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiSpecName Required. The name of the spec to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
ApiSpec |
getApiSpec(GetApiSpecRequest request)
public final ApiSpec getApiSpec(GetApiSpecRequest request)
Returns a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiSpecRequest request =
GetApiSpecRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.build();
ApiSpec response = registryClient.getApiSpec(request);
}
Parameter | |
---|---|
Name | Description |
request | GetApiSpecRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiSpec |
getApiSpec(String name)
public final ApiSpec getApiSpec(String name)
Returns a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]").toString();
ApiSpec response = registryClient.getApiSpec(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the spec to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
ApiSpec |
getApiSpecCallable()
public final UnaryCallable<GetApiSpecRequest,ApiSpec> getApiSpecCallable()
Returns a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiSpecRequest request =
GetApiSpecRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.build();
ApiFuture<ApiSpec> future = registryClient.getApiSpecCallable().futureCall(request);
// Do something.
ApiSpec response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetApiSpecRequest,ApiSpec> |
getApiSpecContents(ApiSpecName name)
public final HttpBody getApiSpecContents(ApiSpecName name)
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiSpecName name = ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
HttpBody response = registryClient.getApiSpecContents(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiSpecName Required. The name of the spec whose contents should be retrieved. Format:
|
Returns | |
---|---|
Type | Description |
com.google.api.HttpBody |
getApiSpecContents(GetApiSpecContentsRequest request)
public final HttpBody getApiSpecContents(GetApiSpecContentsRequest request)
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiSpecContentsRequest request =
GetApiSpecContentsRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.build();
HttpBody response = registryClient.getApiSpecContents(request);
}
Parameter | |
---|---|
Name | Description |
request | GetApiSpecContentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.api.HttpBody |
getApiSpecContents(String name)
public final HttpBody getApiSpecContents(String name)
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]").toString();
HttpBody response = registryClient.getApiSpecContents(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the spec whose contents should be retrieved. Format:
|
Returns | |
---|---|
Type | Description |
com.google.api.HttpBody |
getApiSpecContentsCallable()
public final UnaryCallable<GetApiSpecContentsRequest,HttpBody> getApiSpecContentsCallable()
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiSpecContentsRequest request =
GetApiSpecContentsRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.build();
ApiFuture<HttpBody> future = registryClient.getApiSpecContentsCallable().futureCall(request);
// Do something.
HttpBody response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetApiSpecContentsRequest,com.google.api.HttpBody> |
getApiVersion(ApiVersionName name)
public final ApiVersion getApiVersion(ApiVersionName name)
Returns a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiVersionName name = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
ApiVersion response = registryClient.getApiVersion(name);
}
Parameter | |
---|---|
Name | Description |
name | ApiVersionName Required. The name of the version to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
ApiVersion |
getApiVersion(GetApiVersionRequest request)
public final ApiVersion getApiVersion(GetApiVersionRequest request)
Returns a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiVersionRequest request =
GetApiVersionRequest.newBuilder()
.setName(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.build();
ApiVersion response = registryClient.getApiVersion(request);
}
Parameter | |
---|---|
Name | Description |
request | GetApiVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiVersion |
getApiVersion(String name)
public final ApiVersion getApiVersion(String name)
Returns a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString();
ApiVersion response = registryClient.getApiVersion(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the version to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
ApiVersion |
getApiVersionCallable()
public final UnaryCallable<GetApiVersionRequest,ApiVersion> getApiVersionCallable()
Returns a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetApiVersionRequest request =
GetApiVersionRequest.newBuilder()
.setName(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.build();
ApiFuture<ApiVersion> future = registryClient.getApiVersionCallable().futureCall(request);
// Do something.
ApiVersion response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetApiVersionRequest,ApiVersion> |
getArtifact(ArtifactName name)
public final Artifact getArtifact(ArtifactName name)
Returns a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ArtifactName name =
ArtifactName.ofProjectLocationArtifactName("[PROJECT]", "[LOCATION]", "[ARTIFACT]");
Artifact response = registryClient.getArtifact(name);
}
Parameter | |
---|---|
Name | Description |
name | ArtifactName Required. The name of the artifact to retrieve. Format: |
Returns | |
---|---|
Type | Description |
Artifact |
getArtifact(GetArtifactRequest request)
public final Artifact getArtifact(GetArtifactRequest request)
Returns a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetArtifactRequest request =
GetArtifactRequest.newBuilder()
.setName(
ArtifactName.ofProjectLocationArtifactName(
"[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString())
.build();
Artifact response = registryClient.getArtifact(request);
}
Parameter | |
---|---|
Name | Description |
request | GetArtifactRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Artifact |
getArtifact(String name)
public final Artifact getArtifact(String name)
Returns a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ArtifactName.ofProjectLocationArtifactName("[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString();
Artifact response = registryClient.getArtifact(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the artifact to retrieve. Format: |
Returns | |
---|---|
Type | Description |
Artifact |
getArtifactCallable()
public final UnaryCallable<GetArtifactRequest,Artifact> getArtifactCallable()
Returns a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetArtifactRequest request =
GetArtifactRequest.newBuilder()
.setName(
ArtifactName.ofProjectLocationArtifactName(
"[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString())
.build();
ApiFuture<Artifact> future = registryClient.getArtifactCallable().futureCall(request);
// Do something.
Artifact response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetArtifactRequest,Artifact> |
getArtifactContents(ArtifactName name)
public final HttpBody getArtifactContents(ArtifactName name)
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ArtifactName name =
ArtifactName.ofProjectLocationArtifactName("[PROJECT]", "[LOCATION]", "[ARTIFACT]");
HttpBody response = registryClient.getArtifactContents(name);
}
Parameter | |
---|---|
Name | Description |
name | ArtifactName Required. The name of the artifact whose contents should be retrieved. Format:
|
Returns | |
---|---|
Type | Description |
com.google.api.HttpBody |
getArtifactContents(GetArtifactContentsRequest request)
public final HttpBody getArtifactContents(GetArtifactContentsRequest request)
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetArtifactContentsRequest request =
GetArtifactContentsRequest.newBuilder()
.setName(
ArtifactName.ofProjectLocationArtifactName(
"[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString())
.build();
HttpBody response = registryClient.getArtifactContents(request);
}
Parameter | |
---|---|
Name | Description |
request | GetArtifactContentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.api.HttpBody |
getArtifactContents(String name)
public final HttpBody getArtifactContents(String name)
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String name =
ArtifactName.ofProjectLocationArtifactName("[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString();
HttpBody response = registryClient.getArtifactContents(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the artifact whose contents should be retrieved. Format:
|
Returns | |
---|---|
Type | Description |
com.google.api.HttpBody |
getArtifactContentsCallable()
public final UnaryCallable<GetArtifactContentsRequest,HttpBody> getArtifactContentsCallable()
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).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetArtifactContentsRequest request =
GetArtifactContentsRequest.newBuilder()
.setName(
ArtifactName.ofProjectLocationArtifactName(
"[PROJECT]", "[LOCATION]", "[ARTIFACT]")
.toString())
.build();
ApiFuture<HttpBody> future = registryClient.getArtifactContentsCallable().futureCall(request);
// Do something.
HttpBody response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetArtifactContentsRequest,com.google.api.HttpBody> |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = registryClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = registryClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = registryClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = registryClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final RegistrySettings getSettings()
Returns | |
---|---|
Type | Description |
RegistrySettings |
getStub()
public RegistryStub getStub()
Returns | |
---|---|
Type | Description |
RegistryStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request)
public final RegistryClient.ListApiDeploymentRevisionsPagedResponse listApiDeploymentRevisions(ListApiDeploymentRevisionsRequest request)
Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiDeploymentRevisionsRequest request =
ListApiDeploymentRevisionsRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ApiDeployment element :
registryClient.listApiDeploymentRevisions(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListApiDeploymentRevisionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiDeploymentRevisionsPagedResponse |
listApiDeploymentRevisionsCallable()
public final UnaryCallable<ListApiDeploymentRevisionsRequest,ListApiDeploymentRevisionsResponse> listApiDeploymentRevisionsCallable()
Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiDeploymentRevisionsRequest request =
ListApiDeploymentRevisionsRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListApiDeploymentRevisionsResponse response =
registryClient.listApiDeploymentRevisionsCallable().call(request);
for (ApiDeployment element : response.getApiDeploymentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiDeploymentRevisionsRequest,ListApiDeploymentRevisionsResponse> |
listApiDeploymentRevisionsPagedCallable()
public final UnaryCallable<ListApiDeploymentRevisionsRequest,RegistryClient.ListApiDeploymentRevisionsPagedResponse> listApiDeploymentRevisionsPagedCallable()
Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiDeploymentRevisionsRequest request =
ListApiDeploymentRevisionsRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ApiDeployment> future =
registryClient.listApiDeploymentRevisionsPagedCallable().futureCall(request);
// Do something.
for (ApiDeployment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiDeploymentRevisionsRequest,ListApiDeploymentRevisionsPagedResponse> |
listApiDeployments(ApiName parent)
public final RegistryClient.ListApiDeploymentsPagedResponse listApiDeployments(ApiName parent)
Returns matching deployments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
for (ApiDeployment element : registryClient.listApiDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | ApiName Required. The parent, which owns this collection of deployments. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiDeploymentsPagedResponse |
listApiDeployments(ListApiDeploymentsRequest request)
public final RegistryClient.ListApiDeploymentsPagedResponse listApiDeployments(ListApiDeploymentsRequest request)
Returns matching deployments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiDeploymentsRequest request =
ListApiDeploymentsRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (ApiDeployment element : registryClient.listApiDeployments(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListApiDeploymentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiDeploymentsPagedResponse |
listApiDeployments(String parent)
public final RegistryClient.ListApiDeploymentsPagedResponse listApiDeployments(String parent)
Returns matching deployments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString();
for (ApiDeployment element : registryClient.listApiDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of deployments. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiDeploymentsPagedResponse |
listApiDeploymentsCallable()
public final UnaryCallable<ListApiDeploymentsRequest,ListApiDeploymentsResponse> listApiDeploymentsCallable()
Returns matching deployments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiDeploymentsRequest request =
ListApiDeploymentsRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListApiDeploymentsResponse response =
registryClient.listApiDeploymentsCallable().call(request);
for (ApiDeployment element : response.getApiDeploymentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiDeploymentsRequest,ListApiDeploymentsResponse> |
listApiDeploymentsPagedCallable()
public final UnaryCallable<ListApiDeploymentsRequest,RegistryClient.ListApiDeploymentsPagedResponse> listApiDeploymentsPagedCallable()
Returns matching deployments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiDeploymentsRequest request =
ListApiDeploymentsRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<ApiDeployment> future =
registryClient.listApiDeploymentsPagedCallable().futureCall(request);
// Do something.
for (ApiDeployment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiDeploymentsRequest,ListApiDeploymentsPagedResponse> |
listApiSpecRevisions(ListApiSpecRevisionsRequest request)
public final RegistryClient.ListApiSpecRevisionsPagedResponse listApiSpecRevisions(ListApiSpecRevisionsRequest request)
Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiSpecRevisionsRequest request =
ListApiSpecRevisionsRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ApiSpec element : registryClient.listApiSpecRevisions(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListApiSpecRevisionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiSpecRevisionsPagedResponse |
listApiSpecRevisionsCallable()
public final UnaryCallable<ListApiSpecRevisionsRequest,ListApiSpecRevisionsResponse> listApiSpecRevisionsCallable()
Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiSpecRevisionsRequest request =
ListApiSpecRevisionsRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListApiSpecRevisionsResponse response =
registryClient.listApiSpecRevisionsCallable().call(request);
for (ApiSpec element : response.getApiSpecsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiSpecRevisionsRequest,ListApiSpecRevisionsResponse> |
listApiSpecRevisionsPagedCallable()
public final UnaryCallable<ListApiSpecRevisionsRequest,RegistryClient.ListApiSpecRevisionsPagedResponse> listApiSpecRevisionsPagedCallable()
Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiSpecRevisionsRequest request =
ListApiSpecRevisionsRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ApiSpec> future =
registryClient.listApiSpecRevisionsPagedCallable().futureCall(request);
// Do something.
for (ApiSpec element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiSpecRevisionsRequest,ListApiSpecRevisionsPagedResponse> |
listApiSpecs(ApiVersionName parent)
public final RegistryClient.ListApiSpecsPagedResponse listApiSpecs(ApiVersionName parent)
Returns matching specs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiVersionName parent = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
for (ApiSpec element : registryClient.listApiSpecs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | ApiVersionName Required. The parent, which owns this collection of specs. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiSpecsPagedResponse |
listApiSpecs(ListApiSpecsRequest request)
public final RegistryClient.ListApiSpecsPagedResponse listApiSpecs(ListApiSpecsRequest request)
Returns matching specs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiSpecsRequest request =
ListApiSpecsRequest.newBuilder()
.setParent(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (ApiSpec element : registryClient.listApiSpecs(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListApiSpecsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiSpecsPagedResponse |
listApiSpecs(String parent)
public final RegistryClient.ListApiSpecsPagedResponse listApiSpecs(String parent)
Returns matching specs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString();
for (ApiSpec element : registryClient.listApiSpecs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of specs. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiSpecsPagedResponse |
listApiSpecsCallable()
public final UnaryCallable<ListApiSpecsRequest,ListApiSpecsResponse> listApiSpecsCallable()
Returns matching specs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiSpecsRequest request =
ListApiSpecsRequest.newBuilder()
.setParent(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListApiSpecsResponse response = registryClient.listApiSpecsCallable().call(request);
for (ApiSpec element : response.getApiSpecsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiSpecsRequest,ListApiSpecsResponse> |
listApiSpecsPagedCallable()
public final UnaryCallable<ListApiSpecsRequest,RegistryClient.ListApiSpecsPagedResponse> listApiSpecsPagedCallable()
Returns matching specs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiSpecsRequest request =
ListApiSpecsRequest.newBuilder()
.setParent(
ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<ApiSpec> future = registryClient.listApiSpecsPagedCallable().futureCall(request);
// Do something.
for (ApiSpec element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiSpecsRequest,ListApiSpecsPagedResponse> |
listApiVersions(ApiName parent)
public final RegistryClient.ListApiVersionsPagedResponse listApiVersions(ApiName parent)
Returns matching versions.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
for (ApiVersion element : registryClient.listApiVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | ApiName Required. The parent, which owns this collection of versions. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiVersionsPagedResponse |
listApiVersions(ListApiVersionsRequest request)
public final RegistryClient.ListApiVersionsPagedResponse listApiVersions(ListApiVersionsRequest request)
Returns matching versions.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiVersionsRequest request =
ListApiVersionsRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (ApiVersion element : registryClient.listApiVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListApiVersionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiVersionsPagedResponse |
listApiVersions(String parent)
public final RegistryClient.ListApiVersionsPagedResponse listApiVersions(String parent)
Returns matching versions.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString();
for (ApiVersion element : registryClient.listApiVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of versions. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApiVersionsPagedResponse |
listApiVersionsCallable()
public final UnaryCallable<ListApiVersionsRequest,ListApiVersionsResponse> listApiVersionsCallable()
Returns matching versions.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiVersionsRequest request =
ListApiVersionsRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListApiVersionsResponse response = registryClient.listApiVersionsCallable().call(request);
for (ApiVersion element : response.getApiVersionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiVersionsRequest,ListApiVersionsResponse> |
listApiVersionsPagedCallable()
public final UnaryCallable<ListApiVersionsRequest,RegistryClient.ListApiVersionsPagedResponse> listApiVersionsPagedCallable()
Returns matching versions.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApiVersionsRequest request =
ListApiVersionsRequest.newBuilder()
.setParent(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<ApiVersion> future =
registryClient.listApiVersionsPagedCallable().futureCall(request);
// Do something.
for (ApiVersion element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApiVersionsRequest,ListApiVersionsPagedResponse> |
listApis(ListApisRequest request)
public final RegistryClient.ListApisPagedResponse listApis(ListApisRequest request)
Returns matching APIs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApisRequest request =
ListApisRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (Api element : registryClient.listApis(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListApisRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListApisPagedResponse |
listApis(LocationName parent)
public final RegistryClient.ListApisPagedResponse listApis(LocationName parent)
Returns matching APIs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Api element : registryClient.listApis(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent, which owns this collection of APIs. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApisPagedResponse |
listApis(String parent)
public final RegistryClient.ListApisPagedResponse listApis(String parent)
Returns matching APIs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Api element : registryClient.listApis(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of APIs. Format:
|
Returns | |
---|---|
Type | Description |
RegistryClient.ListApisPagedResponse |
listApisCallable()
public final UnaryCallable<ListApisRequest,ListApisResponse> listApisCallable()
Returns matching APIs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApisRequest request =
ListApisRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListApisResponse response = registryClient.listApisCallable().call(request);
for (Api element : response.getApisList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApisRequest,ListApisResponse> |
listApisPagedCallable()
public final UnaryCallable<ListApisRequest,RegistryClient.ListApisPagedResponse> listApisPagedCallable()
Returns matching APIs.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListApisRequest request =
ListApisRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<Api> future = registryClient.listApisPagedCallable().futureCall(request);
// Do something.
for (Api element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListApisRequest,ListApisPagedResponse> |
listArtifacts(ApiDeploymentName parent)
public final RegistryClient.ListArtifactsPagedResponse listArtifacts(ApiDeploymentName parent)
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiDeploymentName parent =
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]");
for (Artifact element : registryClient.listArtifacts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | ApiDeploymentName Required. The parent, which owns this collection of artifacts. Format: |
Returns | |
---|---|
Type | Description |
RegistryClient.ListArtifactsPagedResponse |
listArtifacts(ApiName parent)
public final RegistryClient.ListArtifactsPagedResponse listArtifacts(ApiName parent)
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiName parent = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
for (Artifact element : registryClient.listArtifacts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | ApiName Required. The parent, which owns this collection of artifacts. Format: |
Returns | |
---|---|
Type | Description |
RegistryClient.ListArtifactsPagedResponse |
listArtifacts(ApiSpecName parent)
public final RegistryClient.ListArtifactsPagedResponse listArtifacts(ApiSpecName parent)
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiSpecName parent =
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]");
for (Artifact element : registryClient.listArtifacts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | ApiSpecName Required. The parent, which owns this collection of artifacts. Format: |
Returns | |
---|---|
Type | Description |
RegistryClient.ListArtifactsPagedResponse |
listArtifacts(ApiVersionName parent)
public final RegistryClient.ListArtifactsPagedResponse listArtifacts(ApiVersionName parent)
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiVersionName parent = ApiVersionName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]");
for (Artifact element : registryClient.listArtifacts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | ApiVersionName Required. The parent, which owns this collection of artifacts. Format: |
Returns | |
---|---|
Type | Description |
RegistryClient.ListArtifactsPagedResponse |
listArtifacts(ListArtifactsRequest request)
public final RegistryClient.ListArtifactsPagedResponse listArtifacts(ListArtifactsRequest request)
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListArtifactsRequest request =
ListArtifactsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (Artifact element : registryClient.listArtifacts(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListArtifactsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListArtifactsPagedResponse |
listArtifacts(LocationName parent)
public final RegistryClient.ListArtifactsPagedResponse listArtifacts(LocationName parent)
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Artifact element : registryClient.listArtifacts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent, which owns this collection of artifacts. Format: |
Returns | |
---|---|
Type | Description |
RegistryClient.ListArtifactsPagedResponse |
listArtifacts(String parent)
public final RegistryClient.ListArtifactsPagedResponse listArtifacts(String parent)
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Artifact element : registryClient.listArtifacts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of artifacts. Format: |
Returns | |
---|---|
Type | Description |
RegistryClient.ListArtifactsPagedResponse |
listArtifactsCallable()
public final UnaryCallable<ListArtifactsRequest,ListArtifactsResponse> listArtifactsCallable()
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListArtifactsRequest request =
ListArtifactsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListArtifactsResponse response = registryClient.listArtifactsCallable().call(request);
for (Artifact element : response.getArtifactsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListArtifactsRequest,ListArtifactsResponse> |
listArtifactsPagedCallable()
public final UnaryCallable<ListArtifactsRequest,RegistryClient.ListArtifactsPagedResponse> listArtifactsPagedCallable()
Returns matching artifacts.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListArtifactsRequest request =
ListArtifactsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<Artifact> future = registryClient.listArtifactsPagedCallable().futureCall(request);
// Do something.
for (Artifact element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListArtifactsRequest,ListArtifactsPagedResponse> |
listLocations(ListLocationsRequest request)
public final RegistryClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : registryClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegistryClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = registryClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,RegistryClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future = registryClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
replaceArtifact(Artifact artifact)
public final Artifact replaceArtifact(Artifact artifact)
Used to replace a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
Artifact artifact = Artifact.newBuilder().build();
Artifact response = registryClient.replaceArtifact(artifact);
}
Parameter | |
---|---|
Name | Description |
artifact | Artifact Required. The artifact to replace. The |
Returns | |
---|---|
Type | Description |
Artifact |
replaceArtifact(ReplaceArtifactRequest request)
public final Artifact replaceArtifact(ReplaceArtifactRequest request)
Used to replace a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ReplaceArtifactRequest request =
ReplaceArtifactRequest.newBuilder().setArtifact(Artifact.newBuilder().build()).build();
Artifact response = registryClient.replaceArtifact(request);
}
Parameter | |
---|---|
Name | Description |
request | ReplaceArtifactRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Artifact |
replaceArtifactCallable()
public final UnaryCallable<ReplaceArtifactRequest,Artifact> replaceArtifactCallable()
Used to replace a specified artifact.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ReplaceArtifactRequest request =
ReplaceArtifactRequest.newBuilder().setArtifact(Artifact.newBuilder().build()).build();
ApiFuture<Artifact> future = registryClient.replaceArtifactCallable().futureCall(request);
// Do something.
Artifact response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ReplaceArtifactRequest,Artifact> |
rollbackApiDeployment(RollbackApiDeploymentRequest request)
public final ApiDeployment rollbackApiDeployment(RollbackApiDeploymentRequest request)
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
RollbackApiDeploymentRequest request =
RollbackApiDeploymentRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setRevisionId("revisionId-1507445162")
.build();
ApiDeployment response = registryClient.rollbackApiDeployment(request);
}
Parameter | |
---|---|
Name | Description |
request | RollbackApiDeploymentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
rollbackApiDeploymentCallable()
public final UnaryCallable<RollbackApiDeploymentRequest,ApiDeployment> rollbackApiDeploymentCallable()
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
RollbackApiDeploymentRequest request =
RollbackApiDeploymentRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setRevisionId("revisionId-1507445162")
.build();
ApiFuture<ApiDeployment> future =
registryClient.rollbackApiDeploymentCallable().futureCall(request);
// Do something.
ApiDeployment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<RollbackApiDeploymentRequest,ApiDeployment> |
rollbackApiSpec(RollbackApiSpecRequest request)
public final ApiSpec rollbackApiSpec(RollbackApiSpecRequest request)
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
RollbackApiSpecRequest request =
RollbackApiSpecRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setRevisionId("revisionId-1507445162")
.build();
ApiSpec response = registryClient.rollbackApiSpec(request);
}
Parameter | |
---|---|
Name | Description |
request | RollbackApiSpecRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiSpec |
rollbackApiSpecCallable()
public final UnaryCallable<RollbackApiSpecRequest,ApiSpec> rollbackApiSpecCallable()
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
RollbackApiSpecRequest request =
RollbackApiSpecRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setRevisionId("revisionId-1507445162")
.build();
ApiFuture<ApiSpec> future = registryClient.rollbackApiSpecCallable().futureCall(request);
// Do something.
ApiSpec response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<RollbackApiSpecRequest,ApiSpec> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = registryClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = registryClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
tagApiDeploymentRevision(TagApiDeploymentRevisionRequest request)
public final ApiDeployment tagApiDeploymentRevision(TagApiDeploymentRevisionRequest request)
Adds a tag to a specified revision of a deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
TagApiDeploymentRevisionRequest request =
TagApiDeploymentRevisionRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setTag("tag114586")
.build();
ApiDeployment response = registryClient.tagApiDeploymentRevision(request);
}
Parameter | |
---|---|
Name | Description |
request | TagApiDeploymentRevisionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
tagApiDeploymentRevisionCallable()
public final UnaryCallable<TagApiDeploymentRevisionRequest,ApiDeployment> tagApiDeploymentRevisionCallable()
Adds a tag to a specified revision of a deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
TagApiDeploymentRevisionRequest request =
TagApiDeploymentRevisionRequest.newBuilder()
.setName(
ApiDeploymentName.of("[PROJECT]", "[LOCATION]", "[API]", "[DEPLOYMENT]")
.toString())
.setTag("tag114586")
.build();
ApiFuture<ApiDeployment> future =
registryClient.tagApiDeploymentRevisionCallable().futureCall(request);
// Do something.
ApiDeployment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<TagApiDeploymentRevisionRequest,ApiDeployment> |
tagApiSpecRevision(TagApiSpecRevisionRequest request)
public final ApiSpec tagApiSpecRevision(TagApiSpecRevisionRequest request)
Adds a tag to a specified revision of a spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
TagApiSpecRevisionRequest request =
TagApiSpecRevisionRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setTag("tag114586")
.build();
ApiSpec response = registryClient.tagApiSpecRevision(request);
}
Parameter | |
---|---|
Name | Description |
request | TagApiSpecRevisionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiSpec |
tagApiSpecRevisionCallable()
public final UnaryCallable<TagApiSpecRevisionRequest,ApiSpec> tagApiSpecRevisionCallable()
Adds a tag to a specified revision of a spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
TagApiSpecRevisionRequest request =
TagApiSpecRevisionRequest.newBuilder()
.setName(
ApiSpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]")
.toString())
.setTag("tag114586")
.build();
ApiFuture<ApiSpec> future = registryClient.tagApiSpecRevisionCallable().futureCall(request);
// Do something.
ApiSpec response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<TagApiSpecRevisionRequest,ApiSpec> |
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = registryClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(ApiName.of("[PROJECT]", "[LOCATION]", "[API]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
registryClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateApi(Api api, FieldMask updateMask)
public final Api updateApi(Api api, FieldMask updateMask)
Used to modify a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
Api api = Api.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Api response = registryClient.updateApi(api, updateMask);
}
Parameters | |
---|---|
Name | Description |
api | Api Required. The API to update. The |
updateMask | FieldMask The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. |
Returns | |
---|---|
Type | Description |
Api |
updateApi(UpdateApiRequest request)
public final Api updateApi(UpdateApiRequest request)
Used to modify a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiRequest request =
UpdateApiRequest.newBuilder()
.setApi(Api.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
Api response = registryClient.updateApi(request);
}
Parameter | |
---|---|
Name | Description |
request | UpdateApiRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Api |
updateApiCallable()
public final UnaryCallable<UpdateApiRequest,Api> updateApiCallable()
Used to modify a specified API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiRequest request =
UpdateApiRequest.newBuilder()
.setApi(Api.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
ApiFuture<Api> future = registryClient.updateApiCallable().futureCall(request);
// Do something.
Api response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateApiRequest,Api> |
updateApiDeployment(ApiDeployment apiDeployment, FieldMask updateMask)
public final ApiDeployment updateApiDeployment(ApiDeployment apiDeployment, FieldMask updateMask)
Used to modify a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiDeployment apiDeployment = ApiDeployment.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ApiDeployment response = registryClient.updateApiDeployment(apiDeployment, updateMask);
}
Parameters | |
---|---|
Name | Description |
apiDeployment | ApiDeployment Required. The deployment to update. The |
updateMask | FieldMask The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
updateApiDeployment(UpdateApiDeploymentRequest request)
public final ApiDeployment updateApiDeployment(UpdateApiDeploymentRequest request)
Used to modify a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiDeploymentRequest request =
UpdateApiDeploymentRequest.newBuilder()
.setApiDeployment(ApiDeployment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
ApiDeployment response = registryClient.updateApiDeployment(request);
}
Parameter | |
---|---|
Name | Description |
request | UpdateApiDeploymentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiDeployment |
updateApiDeploymentCallable()
public final UnaryCallable<UpdateApiDeploymentRequest,ApiDeployment> updateApiDeploymentCallable()
Used to modify a specified deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiDeploymentRequest request =
UpdateApiDeploymentRequest.newBuilder()
.setApiDeployment(ApiDeployment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
ApiFuture<ApiDeployment> future =
registryClient.updateApiDeploymentCallable().futureCall(request);
// Do something.
ApiDeployment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateApiDeploymentRequest,ApiDeployment> |
updateApiSpec(ApiSpec apiSpec, FieldMask updateMask)
public final ApiSpec updateApiSpec(ApiSpec apiSpec, FieldMask updateMask)
Used to modify a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiSpec apiSpec = ApiSpec.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ApiSpec response = registryClient.updateApiSpec(apiSpec, updateMask);
}
Parameters | |
---|---|
Name | Description |
apiSpec | ApiSpec Required. The spec to update. The |
updateMask | FieldMask The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. |
Returns | |
---|---|
Type | Description |
ApiSpec |
updateApiSpec(UpdateApiSpecRequest request)
public final ApiSpec updateApiSpec(UpdateApiSpecRequest request)
Used to modify a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiSpecRequest request =
UpdateApiSpecRequest.newBuilder()
.setApiSpec(ApiSpec.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
ApiSpec response = registryClient.updateApiSpec(request);
}
Parameter | |
---|---|
Name | Description |
request | UpdateApiSpecRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiSpec |
updateApiSpecCallable()
public final UnaryCallable<UpdateApiSpecRequest,ApiSpec> updateApiSpecCallable()
Used to modify a specified spec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiSpecRequest request =
UpdateApiSpecRequest.newBuilder()
.setApiSpec(ApiSpec.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
ApiFuture<ApiSpec> future = registryClient.updateApiSpecCallable().futureCall(request);
// Do something.
ApiSpec response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateApiSpecRequest,ApiSpec> |
updateApiVersion(ApiVersion apiVersion, FieldMask updateMask)
public final ApiVersion updateApiVersion(ApiVersion apiVersion, FieldMask updateMask)
Used to modify a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
ApiVersion apiVersion = ApiVersion.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ApiVersion response = registryClient.updateApiVersion(apiVersion, updateMask);
}
Parameters | |
---|---|
Name | Description |
apiVersion | ApiVersion Required. The version to update. The |
updateMask | FieldMask The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. |
Returns | |
---|---|
Type | Description |
ApiVersion |
updateApiVersion(UpdateApiVersionRequest request)
public final ApiVersion updateApiVersion(UpdateApiVersionRequest request)
Used to modify a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiVersionRequest request =
UpdateApiVersionRequest.newBuilder()
.setApiVersion(ApiVersion.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
ApiVersion response = registryClient.updateApiVersion(request);
}
Parameter | |
---|---|
Name | Description |
request | UpdateApiVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiVersion |
updateApiVersionCallable()
public final UnaryCallable<UpdateApiVersionRequest,ApiVersion> updateApiVersionCallable()
Used to modify a specified version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RegistryClient registryClient = RegistryClient.create()) {
UpdateApiVersionRequest request =
UpdateApiVersionRequest.newBuilder()
.setApiVersion(ApiVersion.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowMissing(true)
.build();
ApiFuture<ApiVersion> future = registryClient.updateApiVersionCallable().futureCall(request);
// Do something.
ApiVersion response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateApiVersionRequest,ApiVersion> |