- 1.50.0 (latest)
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.6
- 1.0.5
- 0.3.7
GitHub Repository | Product Reference |
Service Description: API Overview
The managedidentites.googleapis.com
service implements the Google Cloud Managed Identites
API for identity services (e.g. Microsoft Active Directory).
The Managed Identities service provides methods to manage (create/read/update/delete) domains, reset managed identities admin password, add/remove domain controllers in GCP regions and add/remove VPC peering.
Data Model
The Managed Identities service exposes the following resources:
- Locations as global, named as follows:
projects/{project_id}/locations/global
.
- Domains, named as follows:
/projects/{project_id}/locations/global/domain/{domain_name}
.
The {domain_name}
refers to fully qualified domain name in the customer project e.g.
mydomain.myorganization.com, with the following restrictions:
* Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segement length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
ResetAdminPasswordResponse response = managedIdentitiesServiceClient.resetAdminPassword(name);
}
Note: close() needs to be called on the ManagedIdentitiesServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
CreateMicrosoftAdDomain |
Creates a Microsoft AD domain. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ResetAdminPassword |
Resets a domain's administrator password. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListDomains |
Lists domains in a project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetDomain |
Gets information about a domain. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateDomain |
Updates the metadata and configuration of a domain. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteDomain |
Deletes a domain. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
AttachTrust |
Adds an AD trust to a domain. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ReconfigureTrust |
Updates the DNS conditional forwarder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DetachTrust |
Removes an AD trust. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ValidateTrust |
Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return 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 ManagedIdentitiesServiceSettings 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
ManagedIdentitiesServiceSettings managedIdentitiesServiceSettings =
ManagedIdentitiesServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create(managedIdentitiesServiceSettings);
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
ManagedIdentitiesServiceSettings managedIdentitiesServiceSettings =
ManagedIdentitiesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create(managedIdentitiesServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final ManagedIdentitiesServiceClient create()
Constructs an instance of ManagedIdentitiesServiceClient with default settings.
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ManagedIdentitiesServiceSettings settings)
public static final ManagedIdentitiesServiceClient create(ManagedIdentitiesServiceSettings settings)
Constructs an instance of ManagedIdentitiesServiceClient, 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 |
ManagedIdentitiesServiceSettings |
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ManagedIdentitiesServiceStub stub)
public static final ManagedIdentitiesServiceClient create(ManagedIdentitiesServiceStub stub)
Constructs an instance of ManagedIdentitiesServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ManagedIdentitiesServiceSettings).
Parameter | |
---|---|
Name | Description |
stub |
ManagedIdentitiesServiceStub |
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceClient |
Constructors
ManagedIdentitiesServiceClient(ManagedIdentitiesServiceSettings settings)
protected ManagedIdentitiesServiceClient(ManagedIdentitiesServiceSettings settings)
Constructs an instance of ManagedIdentitiesServiceClient, 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 |
ManagedIdentitiesServiceSettings |
ManagedIdentitiesServiceClient(ManagedIdentitiesServiceStub stub)
protected ManagedIdentitiesServiceClient(ManagedIdentitiesServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
ManagedIdentitiesServiceStub |
Methods
attachTrustAsync(AttachTrustRequest request)
public final OperationFuture<Domain,OpMetadata> attachTrustAsync(AttachTrustRequest request)
Adds an AD trust to a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
AttachTrustRequest request =
AttachTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
Domain response = managedIdentitiesServiceClient.attachTrustAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
AttachTrustRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
attachTrustAsync(DomainName name, Trust trust)
public final OperationFuture<Domain,OpMetadata> attachTrustAsync(DomainName name, Trust trust)
Adds an AD trust to a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
Trust trust = Trust.newBuilder().build();
Domain response = managedIdentitiesServiceClient.attachTrustAsync(name, trust).get();
}
Parameters | |
---|---|
Name | Description |
name |
DomainName Required. The resource domain name, project name and location using the form:
|
trust |
Trust Required. The domain trust resource. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
attachTrustAsync(String name, Trust trust)
public final OperationFuture<Domain,OpMetadata> attachTrustAsync(String name, Trust trust)
Adds an AD trust to a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString();
Trust trust = Trust.newBuilder().build();
Domain response = managedIdentitiesServiceClient.attachTrustAsync(name, trust).get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. The resource domain name, project name and location using the form:
|
trust |
Trust Required. The domain trust resource. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
attachTrustCallable()
public final UnaryCallable<AttachTrustRequest,Operation> attachTrustCallable()
Adds an AD trust to a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
AttachTrustRequest request =
AttachTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
ApiFuture<Operation> future =
managedIdentitiesServiceClient.attachTrustCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AttachTrustRequest,Operation> |
attachTrustOperationCallable()
public final OperationCallable<AttachTrustRequest,Domain,OpMetadata> attachTrustOperationCallable()
Adds an AD trust to a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
AttachTrustRequest request =
AttachTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
OperationFuture<Domain, OpMetadata> future =
managedIdentitiesServiceClient.attachTrustOperationCallable().futureCall(request);
// Do something.
Domain response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<AttachTrustRequest,Domain,OpMetadata> |
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()
createMicrosoftAdDomainAsync(CreateMicrosoftAdDomainRequest request)
public final OperationFuture<Domain,OpMetadata> createMicrosoftAdDomainAsync(CreateMicrosoftAdDomainRequest request)
Creates a Microsoft AD domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
CreateMicrosoftAdDomainRequest request =
CreateMicrosoftAdDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setDomainName("domainName-1244085905")
.setDomain(Domain.newBuilder().build())
.build();
Domain response = managedIdentitiesServiceClient.createMicrosoftAdDomainAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateMicrosoftAdDomainRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
createMicrosoftAdDomainAsync(LocationName parent, String domainName, Domain domain)
public final OperationFuture<Domain,OpMetadata> createMicrosoftAdDomainAsync(LocationName parent, String domainName, Domain domain)
Creates a Microsoft AD domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
String domainName = "domainName-1244085905";
Domain domain = Domain.newBuilder().build();
Domain response =
managedIdentitiesServiceClient
.createMicrosoftAdDomainAsync(parent, domainName, domain)
.get();
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The resource project name and location using the form:
|
domainName |
String Required. The fully qualified domain name. e.g. mydomain.myorganization.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segement length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project. |
domain |
Domain Required. A Managed Identity domain resource. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
createMicrosoftAdDomainAsync(String parent, String domainName, Domain domain)
public final OperationFuture<Domain,OpMetadata> createMicrosoftAdDomainAsync(String parent, String domainName, Domain domain)
Creates a Microsoft AD domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String domainName = "domainName-1244085905";
Domain domain = Domain.newBuilder().build();
Domain response =
managedIdentitiesServiceClient
.createMicrosoftAdDomainAsync(parent, domainName, domain)
.get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The resource project name and location using the form:
|
domainName |
String Required. The fully qualified domain name. e.g. mydomain.myorganization.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segement length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project. |
domain |
Domain Required. A Managed Identity domain resource. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
createMicrosoftAdDomainCallable()
public final UnaryCallable<CreateMicrosoftAdDomainRequest,Operation> createMicrosoftAdDomainCallable()
Creates a Microsoft AD domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
CreateMicrosoftAdDomainRequest request =
CreateMicrosoftAdDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setDomainName("domainName-1244085905")
.setDomain(Domain.newBuilder().build())
.build();
ApiFuture<Operation> future =
managedIdentitiesServiceClient.createMicrosoftAdDomainCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateMicrosoftAdDomainRequest,Operation> |
createMicrosoftAdDomainOperationCallable()
public final OperationCallable<CreateMicrosoftAdDomainRequest,Domain,OpMetadata> createMicrosoftAdDomainOperationCallable()
Creates a Microsoft AD domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
CreateMicrosoftAdDomainRequest request =
CreateMicrosoftAdDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setDomainName("domainName-1244085905")
.setDomain(Domain.newBuilder().build())
.build();
OperationFuture<Domain, OpMetadata> future =
managedIdentitiesServiceClient
.createMicrosoftAdDomainOperationCallable()
.futureCall(request);
// Do something.
Domain response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateMicrosoftAdDomainRequest,Domain,OpMetadata> |
deleteDomainAsync(DeleteDomainRequest request)
public final OperationFuture<Empty,OpMetadata> deleteDomainAsync(DeleteDomainRequest request)
Deletes a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DeleteDomainRequest request =
DeleteDomainRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.build();
managedIdentitiesServiceClient.deleteDomainAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteDomainRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OpMetadata> |
deleteDomainAsync(DomainName name)
public final OperationFuture<Empty,OpMetadata> deleteDomainAsync(DomainName name)
Deletes a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
managedIdentitiesServiceClient.deleteDomainAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
DomainName Required. The domain resource name using the form:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OpMetadata> |
deleteDomainAsync(String name)
public final OperationFuture<Empty,OpMetadata> deleteDomainAsync(String name)
Deletes a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString();
managedIdentitiesServiceClient.deleteDomainAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The domain resource name using the form:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OpMetadata> |
deleteDomainCallable()
public final UnaryCallable<DeleteDomainRequest,Operation> deleteDomainCallable()
Deletes a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DeleteDomainRequest request =
DeleteDomainRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.build();
ApiFuture<Operation> future =
managedIdentitiesServiceClient.deleteDomainCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteDomainRequest,Operation> |
deleteDomainOperationCallable()
public final OperationCallable<DeleteDomainRequest,Empty,OpMetadata> deleteDomainOperationCallable()
Deletes a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DeleteDomainRequest request =
DeleteDomainRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.build();
OperationFuture<Empty, OpMetadata> future =
managedIdentitiesServiceClient.deleteDomainOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteDomainRequest,Empty,OpMetadata> |
detachTrustAsync(DetachTrustRequest request)
public final OperationFuture<Domain,OpMetadata> detachTrustAsync(DetachTrustRequest request)
Removes an AD trust.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DetachTrustRequest request =
DetachTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
Domain response = managedIdentitiesServiceClient.detachTrustAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DetachTrustRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
detachTrustAsync(DomainName name, Trust trust)
public final OperationFuture<Domain,OpMetadata> detachTrustAsync(DomainName name, Trust trust)
Removes an AD trust.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
Trust trust = Trust.newBuilder().build();
Domain response = managedIdentitiesServiceClient.detachTrustAsync(name, trust).get();
}
Parameters | |
---|---|
Name | Description |
name |
DomainName Required. The resource domain name, project name, and location using the form:
|
trust |
Trust Required. The domain trust resource to removed. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
detachTrustAsync(String name, Trust trust)
public final OperationFuture<Domain,OpMetadata> detachTrustAsync(String name, Trust trust)
Removes an AD trust.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString();
Trust trust = Trust.newBuilder().build();
Domain response = managedIdentitiesServiceClient.detachTrustAsync(name, trust).get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. The resource domain name, project name, and location using the form:
|
trust |
Trust Required. The domain trust resource to removed. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
detachTrustCallable()
public final UnaryCallable<DetachTrustRequest,Operation> detachTrustCallable()
Removes an AD trust.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DetachTrustRequest request =
DetachTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
ApiFuture<Operation> future =
managedIdentitiesServiceClient.detachTrustCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DetachTrustRequest,Operation> |
detachTrustOperationCallable()
public final OperationCallable<DetachTrustRequest,Domain,OpMetadata> detachTrustOperationCallable()
Removes an AD trust.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DetachTrustRequest request =
DetachTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
OperationFuture<Domain, OpMetadata> future =
managedIdentitiesServiceClient.detachTrustOperationCallable().futureCall(request);
// Do something.
Domain response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DetachTrustRequest,Domain,OpMetadata> |
getDomain(DomainName name)
public final Domain getDomain(DomainName name)
Gets information about a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
Domain response = managedIdentitiesServiceClient.getDomain(name);
}
Parameter | |
---|---|
Name | Description |
name |
DomainName Required. The domain resource name using the form:
|
Returns | |
---|---|
Type | Description |
Domain |
getDomain(GetDomainRequest request)
public final Domain getDomain(GetDomainRequest request)
Gets information about a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
GetDomainRequest request =
GetDomainRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.build();
Domain response = managedIdentitiesServiceClient.getDomain(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetDomainRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Domain |
getDomain(String name)
public final Domain getDomain(String name)
Gets information about a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString();
Domain response = managedIdentitiesServiceClient.getDomain(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The domain resource name using the form:
|
Returns | |
---|---|
Type | Description |
Domain |
getDomainCallable()
public final UnaryCallable<GetDomainRequest,Domain> getDomainCallable()
Gets information about a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
GetDomainRequest request =
GetDomainRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.build();
ApiFuture<Domain> future =
managedIdentitiesServiceClient.getDomainCallable().futureCall(request);
// Do something.
Domain response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetDomainRequest,Domain> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getSettings()
public final ManagedIdentitiesServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceSettings |
getStub()
public ManagedIdentitiesServiceStub getStub()
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listDomains(ListDomainsRequest request)
public final ManagedIdentitiesServiceClient.ListDomainsPagedResponse listDomains(ListDomainsRequest request)
Lists domains in a project.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ListDomainsRequest request =
ListDomainsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Domain element : managedIdentitiesServiceClient.listDomains(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListDomainsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceClient.ListDomainsPagedResponse |
listDomains(LocationName parent)
public final ManagedIdentitiesServiceClient.ListDomainsPagedResponse listDomains(LocationName parent)
Lists domains in a project.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Domain element : managedIdentitiesServiceClient.listDomains(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The resource name of the domain location using the form:
|
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceClient.ListDomainsPagedResponse |
listDomains(String parent)
public final ManagedIdentitiesServiceClient.ListDomainsPagedResponse listDomains(String parent)
Lists domains in a project.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Domain element : managedIdentitiesServiceClient.listDomains(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The resource name of the domain location using the form:
|
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceClient.ListDomainsPagedResponse |
listDomainsCallable()
public final UnaryCallable<ListDomainsRequest,ListDomainsResponse> listDomainsCallable()
Lists domains in a project.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ListDomainsRequest request =
ListDomainsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListDomainsResponse response =
managedIdentitiesServiceClient.listDomainsCallable().call(request);
for (Domain element : response.getDomainsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDomainsRequest,ListDomainsResponse> |
listDomainsPagedCallable()
public final UnaryCallable<ListDomainsRequest,ManagedIdentitiesServiceClient.ListDomainsPagedResponse> listDomainsPagedCallable()
Lists domains in a project.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ListDomainsRequest request =
ListDomainsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Domain> future =
managedIdentitiesServiceClient.listDomainsPagedCallable().futureCall(request);
// Do something.
for (Domain element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDomainsRequest,ListDomainsPagedResponse> |
reconfigureTrustAsync(DomainName name, String targetDomainName, List<String> targetDnsIpAddresses)
public final OperationFuture<Domain,OpMetadata> reconfigureTrustAsync(DomainName name, String targetDomainName, List<String> targetDnsIpAddresses)
Updates the DNS conditional forwarder.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
String targetDomainName = "targetDomainName2065239520";
List<String> targetDnsIpAddresses = new ArrayList<>();
Domain response =
managedIdentitiesServiceClient
.reconfigureTrustAsync(name, targetDomainName, targetDnsIpAddresses)
.get();
}
Parameters | |
---|---|
Name | Description |
name |
DomainName Required. The resource domain name, project name and location using the form:
|
targetDomainName |
String Required. The fully-qualified target domain name which will be in trust with current domain. |
targetDnsIpAddresses |
List<String> Required. The target DNS server IP addresses to resolve the remote domain involved in the trust. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
reconfigureTrustAsync(ReconfigureTrustRequest request)
public final OperationFuture<Domain,OpMetadata> reconfigureTrustAsync(ReconfigureTrustRequest request)
Updates the DNS conditional forwarder.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ReconfigureTrustRequest request =
ReconfigureTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTargetDomainName("targetDomainName2065239520")
.addAllTargetDnsIpAddresses(new ArrayList<String>())
.build();
Domain response = managedIdentitiesServiceClient.reconfigureTrustAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
ReconfigureTrustRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
reconfigureTrustAsync(String name, String targetDomainName, List<String> targetDnsIpAddresses)
public final OperationFuture<Domain,OpMetadata> reconfigureTrustAsync(String name, String targetDomainName, List<String> targetDnsIpAddresses)
Updates the DNS conditional forwarder.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString();
String targetDomainName = "targetDomainName2065239520";
List<String> targetDnsIpAddresses = new ArrayList<>();
Domain response =
managedIdentitiesServiceClient
.reconfigureTrustAsync(name, targetDomainName, targetDnsIpAddresses)
.get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. The resource domain name, project name and location using the form:
|
targetDomainName |
String Required. The fully-qualified target domain name which will be in trust with current domain. |
targetDnsIpAddresses |
List<String> Required. The target DNS server IP addresses to resolve the remote domain involved in the trust. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
reconfigureTrustCallable()
public final UnaryCallable<ReconfigureTrustRequest,Operation> reconfigureTrustCallable()
Updates the DNS conditional forwarder.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ReconfigureTrustRequest request =
ReconfigureTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTargetDomainName("targetDomainName2065239520")
.addAllTargetDnsIpAddresses(new ArrayList<String>())
.build();
ApiFuture<Operation> future =
managedIdentitiesServiceClient.reconfigureTrustCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ReconfigureTrustRequest,Operation> |
reconfigureTrustOperationCallable()
public final OperationCallable<ReconfigureTrustRequest,Domain,OpMetadata> reconfigureTrustOperationCallable()
Updates the DNS conditional forwarder.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ReconfigureTrustRequest request =
ReconfigureTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTargetDomainName("targetDomainName2065239520")
.addAllTargetDnsIpAddresses(new ArrayList<String>())
.build();
OperationFuture<Domain, OpMetadata> future =
managedIdentitiesServiceClient.reconfigureTrustOperationCallable().futureCall(request);
// Do something.
Domain response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ReconfigureTrustRequest,Domain,OpMetadata> |
resetAdminPassword(DomainName name)
public final ResetAdminPasswordResponse resetAdminPassword(DomainName name)
Resets a domain's administrator password.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
ResetAdminPasswordResponse response = managedIdentitiesServiceClient.resetAdminPassword(name);
}
Parameter | |
---|---|
Name | Description |
name |
DomainName Required. The domain resource name using the form:
|
Returns | |
---|---|
Type | Description |
ResetAdminPasswordResponse |
resetAdminPassword(ResetAdminPasswordRequest request)
public final ResetAdminPasswordResponse resetAdminPassword(ResetAdminPasswordRequest request)
Resets a domain's administrator password.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ResetAdminPasswordRequest request =
ResetAdminPasswordRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.build();
ResetAdminPasswordResponse response =
managedIdentitiesServiceClient.resetAdminPassword(request);
}
Parameter | |
---|---|
Name | Description |
request |
ResetAdminPasswordRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ResetAdminPasswordResponse |
resetAdminPassword(String name)
public final ResetAdminPasswordResponse resetAdminPassword(String name)
Resets a domain's administrator password.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString();
ResetAdminPasswordResponse response = managedIdentitiesServiceClient.resetAdminPassword(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The domain resource name using the form:
|
Returns | |
---|---|
Type | Description |
ResetAdminPasswordResponse |
resetAdminPasswordCallable()
public final UnaryCallable<ResetAdminPasswordRequest,ResetAdminPasswordResponse> resetAdminPasswordCallable()
Resets a domain's administrator password.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ResetAdminPasswordRequest request =
ResetAdminPasswordRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.build();
ApiFuture<ResetAdminPasswordResponse> future =
managedIdentitiesServiceClient.resetAdminPasswordCallable().futureCall(request);
// Do something.
ResetAdminPasswordResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ResetAdminPasswordRequest,ResetAdminPasswordResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateDomainAsync(Domain domain, FieldMask updateMask)
public final OperationFuture<Domain,OpMetadata> updateDomainAsync(Domain domain, FieldMask updateMask)
Updates the metadata and configuration of a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
Domain domain = Domain.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Domain response = managedIdentitiesServiceClient.updateDomainAsync(domain, updateMask).get();
}
Parameters | |
---|---|
Name | Description |
domain |
Domain Required. Domain message with updated fields. Only supported fields specified in update_mask are updated. |
updateMask |
FieldMask Required. Mask of fields to update. At least one path must be supplied in
this field. The elements of the repeated paths field may only include fields from
Domain: * |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
updateDomainAsync(UpdateDomainRequest request)
public final OperationFuture<Domain,OpMetadata> updateDomainAsync(UpdateDomainRequest request)
Updates the metadata and configuration of a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
UpdateDomainRequest request =
UpdateDomainRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setDomain(Domain.newBuilder().build())
.build();
Domain response = managedIdentitiesServiceClient.updateDomainAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
UpdateDomainRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
updateDomainCallable()
public final UnaryCallable<UpdateDomainRequest,Operation> updateDomainCallable()
Updates the metadata and configuration of a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
UpdateDomainRequest request =
UpdateDomainRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setDomain(Domain.newBuilder().build())
.build();
ApiFuture<Operation> future =
managedIdentitiesServiceClient.updateDomainCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateDomainRequest,Operation> |
updateDomainOperationCallable()
public final OperationCallable<UpdateDomainRequest,Domain,OpMetadata> updateDomainOperationCallable()
Updates the metadata and configuration of a domain.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
UpdateDomainRequest request =
UpdateDomainRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setDomain(Domain.newBuilder().build())
.build();
OperationFuture<Domain, OpMetadata> future =
managedIdentitiesServiceClient.updateDomainOperationCallable().futureCall(request);
// Do something.
Domain response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateDomainRequest,Domain,OpMetadata> |
validateTrustAsync(DomainName name, Trust trust)
public final OperationFuture<Domain,OpMetadata> validateTrustAsync(DomainName name, Trust trust)
Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
Trust trust = Trust.newBuilder().build();
Domain response = managedIdentitiesServiceClient.validateTrustAsync(name, trust).get();
}
Parameters | |
---|---|
Name | Description |
name |
DomainName Required. The resource domain name, project name, and location using the form:
|
trust |
Trust Required. The domain trust to validate trust state for. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
validateTrustAsync(ValidateTrustRequest request)
public final OperationFuture<Domain,OpMetadata> validateTrustAsync(ValidateTrustRequest request)
Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ValidateTrustRequest request =
ValidateTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
Domain response = managedIdentitiesServiceClient.validateTrustAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
ValidateTrustRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
validateTrustAsync(String name, Trust trust)
public final OperationFuture<Domain,OpMetadata> validateTrustAsync(String name, Trust trust)
Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
String name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString();
Trust trust = Trust.newBuilder().build();
Domain response = managedIdentitiesServiceClient.validateTrustAsync(name, trust).get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. The resource domain name, project name, and location using the form:
|
trust |
Trust Required. The domain trust to validate trust state for. |
Returns | |
---|---|
Type | Description |
OperationFuture<Domain,OpMetadata> |
validateTrustCallable()
public final UnaryCallable<ValidateTrustRequest,Operation> validateTrustCallable()
Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ValidateTrustRequest request =
ValidateTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
ApiFuture<Operation> future =
managedIdentitiesServiceClient.validateTrustCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ValidateTrustRequest,Operation> |
validateTrustOperationCallable()
public final OperationCallable<ValidateTrustRequest,Domain,OpMetadata> validateTrustOperationCallable()
Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.
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 (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
ValidateTrustRequest request =
ValidateTrustRequest.newBuilder()
.setName(DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]").toString())
.setTrust(Trust.newBuilder().build())
.build();
OperationFuture<Domain, OpMetadata> future =
managedIdentitiesServiceClient.validateTrustOperationCallable().futureCall(request);
// Do something.
Domain response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ValidateTrustRequest,Domain,OpMetadata> |