- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.5
- 2.2.7
public class RegistrationServiceClient implements BackgroundResource
Service Description: Service Directory API for registering services. It defines the following resource model:
- The API has a collection of Namespace
resources, named projects/*/locations/*/namespaces/*
.
- Each Namespace has a collection of Service
resources, named projects/*/locations/*/namespaces/*/services/*
.
- Each Service has a collection of Endpoint
resources, named
projects/*/locations/*/namespaces/*/services/*/endpoints/*
.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Namespace namespace = Namespace.newBuilder().build();
String namespaceId = "namespaceId790852566";
Namespace response =
registrationServiceClient.createNamespace(parent, namespace, namespaceId);
}
Note: close() needs to be called on the RegistrationServiceClient 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 RegistrationServiceSettings 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
RegistrationServiceSettings registrationServiceSettings =
RegistrationServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RegistrationServiceClient registrationServiceClient =
RegistrationServiceClient.create(registrationServiceSettings);
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
RegistrationServiceSettings registrationServiceSettings =
RegistrationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
RegistrationServiceClient registrationServiceClient =
RegistrationServiceClient.create(registrationServiceSettings);
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
RegistrationServiceSettings registrationServiceSettings =
RegistrationServiceSettings.newBuilder()
.setTransportChannelProvider(
RegistrationServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
RegistrationServiceClient registrationServiceClient =
RegistrationServiceClient.create(registrationServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final RegistrationServiceClient create()
Constructs an instance of RegistrationServiceClient with default settings.
Type | Description |
RegistrationServiceClient |
Type | Description |
IOException |
create(RegistrationServiceSettings settings)
public static final RegistrationServiceClient create(RegistrationServiceSettings settings)
Constructs an instance of RegistrationServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | RegistrationServiceSettings |
Type | Description |
RegistrationServiceClient |
Type | Description |
IOException |
create(RegistrationServiceStub stub)
public static final RegistrationServiceClient create(RegistrationServiceStub stub)
Constructs an instance of RegistrationServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegistrationServiceSettings).
Name | Description |
stub | RegistrationServiceStub |
Type | Description |
RegistrationServiceClient |
Constructors
RegistrationServiceClient(RegistrationServiceSettings settings)
protected RegistrationServiceClient(RegistrationServiceSettings settings)
Constructs an instance of RegistrationServiceClient, 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.
Name | Description |
settings | RegistrationServiceSettings |
RegistrationServiceClient(RegistrationServiceStub stub)
protected RegistrationServiceClient(RegistrationServiceStub stub)
Name | Description |
stub | RegistrationServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createEndpoint(CreateEndpointRequest request)
public final Endpoint createEndpoint(CreateEndpointRequest request)
Creates an endpoint, and returns the new endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.setEndpointId("endpointId-1837754992")
.setEndpoint(Endpoint.newBuilder().build())
.build();
Endpoint response = registrationServiceClient.createEndpoint(request);
}
Name | Description |
request | CreateEndpointRequest The request object containing all of the parameters for the API call. |
Type | Description |
Endpoint |
createEndpoint(ServiceName parent, Endpoint endpoint, String endpointId)
public final Endpoint createEndpoint(ServiceName parent, Endpoint endpoint, String endpointId)
Creates an endpoint, and returns the new endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]");
Endpoint endpoint = Endpoint.newBuilder().build();
String endpointId = "endpointId-1837754992";
Endpoint response = registrationServiceClient.createEndpoint(parent, endpoint, endpointId);
}
Name | Description |
parent | ServiceName Required. The resource name of the service that this endpoint provides. |
endpoint | Endpoint Required. A endpoint with initial fields set. |
endpointId | String Required. The Resource ID must be 1-63 characters long, and comply with <a
href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
Specifically, the name must be 1-63 characters long and match the regular expression
|
Type | Description |
Endpoint |
createEndpoint(String parent, Endpoint endpoint, String endpointId)
public final Endpoint createEndpoint(String parent, Endpoint endpoint, String endpointId)
Creates an endpoint, and returns the new endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String parent =
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString();
Endpoint endpoint = Endpoint.newBuilder().build();
String endpointId = "endpointId-1837754992";
Endpoint response = registrationServiceClient.createEndpoint(parent, endpoint, endpointId);
}
Name | Description |
parent | String Required. The resource name of the service that this endpoint provides. |
endpoint | Endpoint Required. A endpoint with initial fields set. |
endpointId | String Required. The Resource ID must be 1-63 characters long, and comply with <a
href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
Specifically, the name must be 1-63 characters long and match the regular expression
|
Type | Description |
Endpoint |
createEndpointCallable()
public final UnaryCallable<CreateEndpointRequest,Endpoint> createEndpointCallable()
Creates an endpoint, and returns the new endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.setEndpointId("endpointId-1837754992")
.setEndpoint(Endpoint.newBuilder().build())
.build();
ApiFuture<Endpoint> future =
registrationServiceClient.createEndpointCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Type | Description |
UnaryCallable<CreateEndpointRequest,Endpoint> |
createNamespace(CreateNamespaceRequest request)
public final Namespace createNamespace(CreateNamespaceRequest request)
Creates a namespace, and returns the new namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
CreateNamespaceRequest request =
CreateNamespaceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setNamespaceId("namespaceId790852566")
.setNamespace(Namespace.newBuilder().build())
.build();
Namespace response = registrationServiceClient.createNamespace(request);
}
Name | Description |
request | CreateNamespaceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Namespace |
createNamespace(LocationName parent, Namespace namespace, String namespaceId)
public final Namespace createNamespace(LocationName parent, Namespace namespace, String namespaceId)
Creates a namespace, and returns the new namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Namespace namespace = Namespace.newBuilder().build();
String namespaceId = "namespaceId790852566";
Namespace response =
registrationServiceClient.createNamespace(parent, namespace, namespaceId);
}
Name | Description |
parent | LocationName Required. The resource name of the project and location the namespace will be created in. |
namespace | Namespace Required. A namespace with initial fields set. |
namespaceId | String Required. The Resource ID must be 1-63 characters long, and comply with
<a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
Specifically, the name must be 1-63 characters long and match the regular expression
|
Type | Description |
Namespace |
createNamespace(String parent, Namespace namespace, String namespaceId)
public final Namespace createNamespace(String parent, Namespace namespace, String namespaceId)
Creates a namespace, and returns the new namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Namespace namespace = Namespace.newBuilder().build();
String namespaceId = "namespaceId790852566";
Namespace response =
registrationServiceClient.createNamespace(parent, namespace, namespaceId);
}
Name | Description |
parent | String Required. The resource name of the project and location the namespace will be created in. |
namespace | Namespace Required. A namespace with initial fields set. |
namespaceId | String Required. The Resource ID must be 1-63 characters long, and comply with
<a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
Specifically, the name must be 1-63 characters long and match the regular expression
|
Type | Description |
Namespace |
createNamespaceCallable()
public final UnaryCallable<CreateNamespaceRequest,Namespace> createNamespaceCallable()
Creates a namespace, and returns the new namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
CreateNamespaceRequest request =
CreateNamespaceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setNamespaceId("namespaceId790852566")
.setNamespace(Namespace.newBuilder().build())
.build();
ApiFuture<Namespace> future =
registrationServiceClient.createNamespaceCallable().futureCall(request);
// Do something.
Namespace response = future.get();
}
Type | Description |
UnaryCallable<CreateNamespaceRequest,Namespace> |
createService(CreateServiceRequest request)
public final Service createService(CreateServiceRequest request)
Creates a service, and returns the new 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.build();
Service response = registrationServiceClient.createService(request);
}
Name | Description |
request | CreateServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Service |
createService(NamespaceName parent, Service service, String serviceId)
public final Service createService(NamespaceName parent, Service service, String serviceId)
Creates a service, and returns the new 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
NamespaceName parent = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]");
Service service = Service.newBuilder().build();
String serviceId = "serviceId-194185552";
Service response = registrationServiceClient.createService(parent, service, serviceId);
}
Name | Description |
parent | NamespaceName Required. The resource name of the namespace this service will belong to. |
service | Service Required. A service with initial fields set. |
serviceId | String Required. The Resource ID must be 1-63 characters long, and comply with <a
href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
Specifically, the name must be 1-63 characters long and match the regular expression
|
Type | Description |
Service |
createService(String parent, Service service, String serviceId)
public final Service createService(String parent, Service service, String serviceId)
Creates a service, and returns the new 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String parent = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString();
Service service = Service.newBuilder().build();
String serviceId = "serviceId-194185552";
Service response = registrationServiceClient.createService(parent, service, serviceId);
}
Name | Description |
parent | String Required. The resource name of the namespace this service will belong to. |
service | Service Required. A service with initial fields set. |
serviceId | String Required. The Resource ID must be 1-63 characters long, and comply with <a
href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
Specifically, the name must be 1-63 characters long and match the regular expression
|
Type | Description |
Service |
createServiceCallable()
public final UnaryCallable<CreateServiceRequest,Service> createServiceCallable()
Creates a service, and returns the new 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.build();
ApiFuture<Service> future =
registrationServiceClient.createServiceCallable().futureCall(request);
// Do something.
Service response = future.get();
}
Type | Description |
UnaryCallable<CreateServiceRequest,Service> |
deleteEndpoint(DeleteEndpointRequest request)
public final void deleteEndpoint(DeleteEndpointRequest request)
Deletes an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(
EndpointName.of(
"[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]")
.toString())
.build();
registrationServiceClient.deleteEndpoint(request);
}
Name | Description |
request | DeleteEndpointRequest The request object containing all of the parameters for the API call. |
deleteEndpoint(EndpointName name)
public final void deleteEndpoint(EndpointName name)
Deletes an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
EndpointName name =
EndpointName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]");
registrationServiceClient.deleteEndpoint(name);
}
Name | Description |
name | EndpointName Required. The name of the endpoint to delete. |
deleteEndpoint(String name)
public final void deleteEndpoint(String name)
Deletes an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String name =
EndpointName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]")
.toString();
registrationServiceClient.deleteEndpoint(name);
}
Name | Description |
name | String Required. The name of the endpoint to delete. |
deleteEndpointCallable()
public final UnaryCallable<DeleteEndpointRequest,Empty> deleteEndpointCallable()
Deletes an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(
EndpointName.of(
"[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]")
.toString())
.build();
ApiFuture<Empty> future =
registrationServiceClient.deleteEndpointCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteEndpointRequest,Empty> |
deleteNamespace(DeleteNamespaceRequest request)
public final void deleteNamespace(DeleteNamespaceRequest request)
Deletes a namespace. This also deletes all services and endpoints in the namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
DeleteNamespaceRequest request =
DeleteNamespaceRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.build();
registrationServiceClient.deleteNamespace(request);
}
Name | Description |
request | DeleteNamespaceRequest The request object containing all of the parameters for the API call. |
deleteNamespace(NamespaceName name)
public final void deleteNamespace(NamespaceName name)
Deletes a namespace. This also deletes all services and endpoints in the namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
NamespaceName name = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]");
registrationServiceClient.deleteNamespace(name);
}
Name | Description |
name | NamespaceName Required. The name of the namespace to delete. |
deleteNamespace(String name)
public final void deleteNamespace(String name)
Deletes a namespace. This also deletes all services and endpoints in the namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String name = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString();
registrationServiceClient.deleteNamespace(name);
}
Name | Description |
name | String Required. The name of the namespace to delete. |
deleteNamespaceCallable()
public final UnaryCallable<DeleteNamespaceRequest,Empty> deleteNamespaceCallable()
Deletes a namespace. This also deletes all services and endpoints in the namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
DeleteNamespaceRequest request =
DeleteNamespaceRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.build();
ApiFuture<Empty> future =
registrationServiceClient.deleteNamespaceCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteNamespaceRequest,Empty> |
deleteService(DeleteServiceRequest request)
public final void deleteService(DeleteServiceRequest request)
Deletes a service. This also deletes all endpoints associated with the 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.build();
registrationServiceClient.deleteService(request);
}
Name | Description |
request | DeleteServiceRequest The request object containing all of the parameters for the API call. |
deleteService(ServiceName name)
public final void deleteService(ServiceName name)
Deletes a service. This also deletes all endpoints associated with the 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]");
registrationServiceClient.deleteService(name);
}
Name | Description |
name | ServiceName Required. The name of the service to delete. |
deleteService(String name)
public final void deleteService(String name)
Deletes a service. This also deletes all endpoints associated with the 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String name =
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString();
registrationServiceClient.deleteService(name);
}
Name | Description |
name | String Required. The name of the service to delete. |
deleteServiceCallable()
public final UnaryCallable<DeleteServiceRequest,Empty> deleteServiceCallable()
Deletes a service. This also deletes all endpoints associated with the 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.build();
ApiFuture<Empty> future =
registrationServiceClient.deleteServiceCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteServiceRequest,Empty> |
getEndpoint(EndpointName name)
public final Endpoint getEndpoint(EndpointName name)
Gets an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
EndpointName name =
EndpointName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]");
Endpoint response = registrationServiceClient.getEndpoint(name);
}
Name | Description |
name | EndpointName Required. The name of the endpoint to get. |
Type | Description |
Endpoint |
getEndpoint(GetEndpointRequest request)
public final Endpoint getEndpoint(GetEndpointRequest request)
Gets an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(
EndpointName.of(
"[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]")
.toString())
.build();
Endpoint response = registrationServiceClient.getEndpoint(request);
}
Name | Description |
request | GetEndpointRequest The request object containing all of the parameters for the API call. |
Type | Description |
Endpoint |
getEndpoint(String name)
public final Endpoint getEndpoint(String name)
Gets an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String name =
EndpointName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]")
.toString();
Endpoint response = registrationServiceClient.getEndpoint(name);
}
Name | Description |
name | String Required. The name of the endpoint to get. |
Type | Description |
Endpoint |
getEndpointCallable()
public final UnaryCallable<GetEndpointRequest,Endpoint> getEndpointCallable()
Gets an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(
EndpointName.of(
"[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]", "[ENDPOINT]")
.toString())
.build();
ApiFuture<Endpoint> future =
registrationServiceClient.getEndpointCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Type | Description |
UnaryCallable<GetEndpointRequest,Endpoint> |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)
Gets the IAM Policy for a resource (namespace or service only).
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = registrationServiceClient.getIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the IAM Policy for a resource (namespace or service only).
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
registrationServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getNamespace(GetNamespaceRequest request)
public final Namespace getNamespace(GetNamespaceRequest request)
Gets a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetNamespaceRequest request =
GetNamespaceRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.build();
Namespace response = registrationServiceClient.getNamespace(request);
}
Name | Description |
request | GetNamespaceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Namespace |
getNamespace(NamespaceName name)
public final Namespace getNamespace(NamespaceName name)
Gets a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
NamespaceName name = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]");
Namespace response = registrationServiceClient.getNamespace(name);
}
Name | Description |
name | NamespaceName Required. The name of the namespace to retrieve. |
Type | Description |
Namespace |
getNamespace(String name)
public final Namespace getNamespace(String name)
Gets a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String name = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString();
Namespace response = registrationServiceClient.getNamespace(name);
}
Name | Description |
name | String Required. The name of the namespace to retrieve. |
Type | Description |
Namespace |
getNamespaceCallable()
public final UnaryCallable<GetNamespaceRequest,Namespace> getNamespaceCallable()
Gets a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetNamespaceRequest request =
GetNamespaceRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.build();
ApiFuture<Namespace> future =
registrationServiceClient.getNamespaceCallable().futureCall(request);
// Do something.
Namespace response = future.get();
}
Type | Description |
UnaryCallable<GetNamespaceRequest,Namespace> |
getService(GetServiceRequest request)
public final Service getService(GetServiceRequest request)
Gets a 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetServiceRequest request =
GetServiceRequest.newBuilder()
.setName(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.build();
Service response = registrationServiceClient.getService(request);
}
Name | Description |
request | GetServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Service |
getService(ServiceName name)
public final Service getService(ServiceName name)
Gets a 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]");
Service response = registrationServiceClient.getService(name);
}
Name | Description |
name | ServiceName Required. The name of the service to get. |
Type | Description |
Service |
getService(String name)
public final Service getService(String name)
Gets a 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String name =
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString();
Service response = registrationServiceClient.getService(name);
}
Name | Description |
name | String Required. The name of the service to get. |
Type | Description |
Service |
getServiceCallable()
public final UnaryCallable<GetServiceRequest,Service> getServiceCallable()
Gets a 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
GetServiceRequest request =
GetServiceRequest.newBuilder()
.setName(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.build();
ApiFuture<Service> future =
registrationServiceClient.getServiceCallable().futureCall(request);
// Do something.
Service response = future.get();
}
Type | Description |
UnaryCallable<GetServiceRequest,Service> |
getSettings()
public final RegistrationServiceSettings getSettings()
Type | Description |
RegistrationServiceSettings |
getStub()
public RegistrationServiceStub getStub()
Type | Description |
RegistrationServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listEndpoints(ListEndpointsRequest request)
public final RegistrationServiceClient.ListEndpointsPagedResponse listEndpoints(ListEndpointsRequest request)
Lists all endpoints.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Endpoint element : registrationServiceClient.listEndpoints(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListEndpointsRequest The request object containing all of the parameters for the API call. |
Type | Description |
RegistrationServiceClient.ListEndpointsPagedResponse |
listEndpoints(ServiceName parent)
public final RegistrationServiceClient.ListEndpointsPagedResponse listEndpoints(ServiceName parent)
Lists all endpoints.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]");
for (Endpoint element : registrationServiceClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | ServiceName Required. The resource name of the service whose endpoints you'd like to list. |
Type | Description |
RegistrationServiceClient.ListEndpointsPagedResponse |
listEndpoints(String parent)
public final RegistrationServiceClient.ListEndpointsPagedResponse listEndpoints(String parent)
Lists all endpoints.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String parent =
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString();
for (Endpoint element : registrationServiceClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the service whose endpoints you'd like to list. |
Type | Description |
RegistrationServiceClient.ListEndpointsPagedResponse |
listEndpointsCallable()
public final UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> listEndpointsCallable()
Lists all endpoints.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListEndpointsResponse response =
registrationServiceClient.listEndpointsCallable().call(request);
for (Endpoint element : response.getEndpointsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> |
listEndpointsPagedCallable()
public final UnaryCallable<ListEndpointsRequest,RegistrationServiceClient.ListEndpointsPagedResponse> listEndpointsPagedCallable()
Lists all endpoints.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(
ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Endpoint> future =
registrationServiceClient.listEndpointsPagedCallable().futureCall(request);
// Do something.
for (Endpoint element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsPagedResponse> |
listNamespaces(ListNamespacesRequest request)
public final RegistrationServiceClient.ListNamespacesPagedResponse listNamespaces(ListNamespacesRequest request)
Lists all namespaces.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListNamespacesRequest request =
ListNamespacesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Namespace element : registrationServiceClient.listNamespaces(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListNamespacesRequest The request object containing all of the parameters for the API call. |
Type | Description |
RegistrationServiceClient.ListNamespacesPagedResponse |
listNamespaces(LocationName parent)
public final RegistrationServiceClient.ListNamespacesPagedResponse listNamespaces(LocationName parent)
Lists all namespaces.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Namespace element : registrationServiceClient.listNamespaces(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The resource name of the project and location whose namespaces you'd like to list. |
Type | Description |
RegistrationServiceClient.ListNamespacesPagedResponse |
listNamespaces(String parent)
public final RegistrationServiceClient.ListNamespacesPagedResponse listNamespaces(String parent)
Lists all namespaces.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Namespace element : registrationServiceClient.listNamespaces(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the project and location whose namespaces you'd like to list. |
Type | Description |
RegistrationServiceClient.ListNamespacesPagedResponse |
listNamespacesCallable()
public final UnaryCallable<ListNamespacesRequest,ListNamespacesResponse> listNamespacesCallable()
Lists all namespaces.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListNamespacesRequest request =
ListNamespacesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListNamespacesResponse response =
registrationServiceClient.listNamespacesCallable().call(request);
for (Namespace element : response.getNamespacesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListNamespacesRequest,ListNamespacesResponse> |
listNamespacesPagedCallable()
public final UnaryCallable<ListNamespacesRequest,RegistrationServiceClient.ListNamespacesPagedResponse> listNamespacesPagedCallable()
Lists all namespaces.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListNamespacesRequest request =
ListNamespacesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Namespace> future =
registrationServiceClient.listNamespacesPagedCallable().futureCall(request);
// Do something.
for (Namespace element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListNamespacesRequest,ListNamespacesPagedResponse> |
listServices(ListServicesRequest request)
public final RegistrationServiceClient.ListServicesPagedResponse listServices(ListServicesRequest request)
Lists all services belonging to a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Service element : registrationServiceClient.listServices(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListServicesRequest The request object containing all of the parameters for the API call. |
Type | Description |
RegistrationServiceClient.ListServicesPagedResponse |
listServices(NamespaceName parent)
public final RegistrationServiceClient.ListServicesPagedResponse listServices(NamespaceName parent)
Lists all services belonging to a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
NamespaceName parent = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]");
for (Service element : registrationServiceClient.listServices(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | NamespaceName Required. The resource name of the namespace whose services you'd like to list. |
Type | Description |
RegistrationServiceClient.ListServicesPagedResponse |
listServices(String parent)
public final RegistrationServiceClient.ListServicesPagedResponse listServices(String parent)
Lists all services belonging to a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
String parent = NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString();
for (Service element : registrationServiceClient.listServices(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the namespace whose services you'd like to list. |
Type | Description |
RegistrationServiceClient.ListServicesPagedResponse |
listServicesCallable()
public final UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()
Lists all services belonging to a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListServicesResponse response =
registrationServiceClient.listServicesCallable().call(request);
for (Service element : response.getServicesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListServicesRequest,ListServicesResponse> |
listServicesPagedCallable()
public final UnaryCallable<ListServicesRequest,RegistrationServiceClient.ListServicesPagedResponse> listServicesPagedCallable()
Lists all services belonging to a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Service> future =
registrationServiceClient.listServicesPagedCallable().futureCall(request);
// Do something.
for (Service element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListServicesRequest,ListServicesPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)
Sets the IAM Policy for a resource (namespace or service only).
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = registrationServiceClient.setIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
Sets the IAM Policy for a resource (namespace or service only).
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future =
registrationServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
Tests IAM permissions for a resource (namespace or service only).
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = registrationServiceClient.testIamPermissions(request);
}
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
Tests IAM permissions for a resource (namespace or service only).
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(NamespaceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
registrationServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateEndpoint(Endpoint endpoint, FieldMask updateMask)
public final Endpoint updateEndpoint(Endpoint endpoint, FieldMask updateMask)
Updates an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
Endpoint endpoint = Endpoint.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Endpoint response = registrationServiceClient.updateEndpoint(endpoint, updateMask);
}
Name | Description |
endpoint | Endpoint Required. The updated endpoint. |
updateMask | FieldMask Required. List of fields to be updated in this request. |
Type | Description |
Endpoint |
updateEndpoint(UpdateEndpointRequest request)
public final Endpoint updateEndpoint(UpdateEndpointRequest request)
Updates an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
UpdateEndpointRequest request =
UpdateEndpointRequest.newBuilder()
.setEndpoint(Endpoint.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Endpoint response = registrationServiceClient.updateEndpoint(request);
}
Name | Description |
request | UpdateEndpointRequest The request object containing all of the parameters for the API call. |
Type | Description |
Endpoint |
updateEndpointCallable()
public final UnaryCallable<UpdateEndpointRequest,Endpoint> updateEndpointCallable()
Updates an endpoint.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
UpdateEndpointRequest request =
UpdateEndpointRequest.newBuilder()
.setEndpoint(Endpoint.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Endpoint> future =
registrationServiceClient.updateEndpointCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Type | Description |
UnaryCallable<UpdateEndpointRequest,Endpoint> |
updateNamespace(Namespace namespace, FieldMask updateMask)
public final Namespace updateNamespace(Namespace namespace, FieldMask updateMask)
Updates a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
Namespace namespace = Namespace.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Namespace response = registrationServiceClient.updateNamespace(namespace, updateMask);
}
Name | Description |
namespace | Namespace Required. The updated namespace. |
updateMask | FieldMask Required. List of fields to be updated in this request. |
Type | Description |
Namespace |
updateNamespace(UpdateNamespaceRequest request)
public final Namespace updateNamespace(UpdateNamespaceRequest request)
Updates a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
UpdateNamespaceRequest request =
UpdateNamespaceRequest.newBuilder()
.setNamespace(Namespace.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Namespace response = registrationServiceClient.updateNamespace(request);
}
Name | Description |
request | UpdateNamespaceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Namespace |
updateNamespaceCallable()
public final UnaryCallable<UpdateNamespaceRequest,Namespace> updateNamespaceCallable()
Updates a namespace.
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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
UpdateNamespaceRequest request =
UpdateNamespaceRequest.newBuilder()
.setNamespace(Namespace.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Namespace> future =
registrationServiceClient.updateNamespaceCallable().futureCall(request);
// Do something.
Namespace response = future.get();
}
Type | Description |
UnaryCallable<UpdateNamespaceRequest,Namespace> |
updateService(Service service, FieldMask updateMask)
public final Service updateService(Service service, FieldMask updateMask)
Updates a 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
Service service = Service.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Service response = registrationServiceClient.updateService(service, updateMask);
}
Name | Description |
service | Service Required. The updated service. |
updateMask | FieldMask Required. List of fields to be updated in this request. |
Type | Description |
Service |
updateService(UpdateServiceRequest request)
public final Service updateService(UpdateServiceRequest request)
Updates a 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setService(Service.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Service response = registrationServiceClient.updateService(request);
}
Name | Description |
request | UpdateServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Service |
updateServiceCallable()
public final UnaryCallable<UpdateServiceRequest,Service> updateServiceCallable()
Updates a 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 (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setService(Service.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Service> future =
registrationServiceClient.updateServiceCallable().futureCall(request);
// Do something.
Service response = future.get();
}
Type | Description |
UnaryCallable<UpdateServiceRequest,Service> |