Package com.google.cloud.managedidentities.v1 (1.27.0)

A client to Managed Service for Microsoft Active Directory API

The interfaces provided are listed below, along with usage samples.

ManagedIdentitiesServiceClient

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.

Sample for ManagedIdentitiesServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying 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);
 }

Classes

AttachTrustRequest

Request message for AttachTrust

Protobuf type google.cloud.managedidentities.v1.AttachTrustRequest

AttachTrustRequest.Builder

Request message for AttachTrust

Protobuf type google.cloud.managedidentities.v1.AttachTrustRequest

CreateMicrosoftAdDomainRequest

Request message for CreateMicrosoftAdDomain

Protobuf type google.cloud.managedidentities.v1.CreateMicrosoftAdDomainRequest

CreateMicrosoftAdDomainRequest.Builder

Request message for CreateMicrosoftAdDomain

Protobuf type google.cloud.managedidentities.v1.CreateMicrosoftAdDomainRequest

DeleteDomainRequest

Request message for DeleteDomain

Protobuf type google.cloud.managedidentities.v1.DeleteDomainRequest

DeleteDomainRequest.Builder

Request message for DeleteDomain

Protobuf type google.cloud.managedidentities.v1.DeleteDomainRequest

DetachTrustRequest

Request message for DetachTrust

Protobuf type google.cloud.managedidentities.v1.DetachTrustRequest

DetachTrustRequest.Builder

Request message for DetachTrust

Protobuf type google.cloud.managedidentities.v1.DetachTrustRequest

Domain

Represents a managed Microsoft Active Directory domain.

Protobuf type google.cloud.managedidentities.v1.Domain

Domain.Builder

Represents a managed Microsoft Active Directory domain.

Protobuf type google.cloud.managedidentities.v1.Domain

DomainName

DomainName.Builder

Builder for projects/{project}/locations/{location}/domains/{domain}.

GetDomainRequest

Request message for GetDomain

Protobuf type google.cloud.managedidentities.v1.GetDomainRequest

GetDomainRequest.Builder

Request message for GetDomain

Protobuf type google.cloud.managedidentities.v1.GetDomainRequest

ListDomainsRequest

Request message for ListDomains

Protobuf type google.cloud.managedidentities.v1.ListDomainsRequest

ListDomainsRequest.Builder

Request message for ListDomains

Protobuf type google.cloud.managedidentities.v1.ListDomainsRequest

ListDomainsResponse

Response message for ListDomains

Protobuf type google.cloud.managedidentities.v1.ListDomainsResponse

ListDomainsResponse.Builder

Response message for ListDomains

Protobuf type google.cloud.managedidentities.v1.ListDomainsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

ManagedIdentitiesServiceClient

Service Description: API Overview

The managedidentites.googleapis.com service implements the Google Cloud Managed Identites API for identity services (e.g. Microsoft Active Directory).

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:

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().

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 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.

ManagedIdentitiesServiceClient.ListDomainsFixedSizeCollection

ManagedIdentitiesServiceClient.ListDomainsPage

ManagedIdentitiesServiceClient.ListDomainsPagedResponse

ManagedIdentitiesServiceGrpc

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.

ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service ManagedIdentitiesService.

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.

ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service ManagedIdentitiesService.

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.

ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceImplBase

Base class for the server implementation of the service ManagedIdentitiesService.

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.

ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceStub

A stub to allow clients to do asynchronous rpc calls to service ManagedIdentitiesService.

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.

ManagedIdentitiesServiceProto

ManagedIdentitiesServiceSettings

Settings class to configure an instance of ManagedIdentitiesServiceClient.

The default instance has everything set to sensible defaults:

The default service address (managedidentities.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of resetAdminPassword to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require 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.Builder managedIdentitiesServiceSettingsBuilder =
     ManagedIdentitiesServiceSettings.newBuilder();
 managedIdentitiesServiceSettingsBuilder
     .resetAdminPasswordSettings()
     .setRetrySettings(
         managedIdentitiesServiceSettingsBuilder
             .resetAdminPasswordSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ManagedIdentitiesServiceSettings managedIdentitiesServiceSettings =
     managedIdentitiesServiceSettingsBuilder.build();

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.

Package com.google.cloud.managedidentities.v1 (1.27.0)

ManagedIdentitiesServiceClient

Classes

Interfaces

Enums