Class OsLoginServiceClient (2.41.0)

Service Description: Cloud OS Login API

The Cloud OS Login API allows you to manage users and their associated SSH public keys for logging into virtual machines on Google Cloud Platform.

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 (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   UserName parent = UserName.of("[USER]");
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   OsLoginProto.SshPublicKey response =
       osLoginServiceClient.createSshPublicKey(parent, sshPublicKey);
 }

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

Methods
Method	Description	Method Variants
CreateSshPublicKey	Create an SSH public key	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSshPublicKey(CreateSshPublicKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey) createSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createSshPublicKeyCallable()
DeletePosixAccount	Deletes a POSIX account.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deletePosixAccount(DeletePosixAccountRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deletePosixAccount(ProjectName name) deletePosixAccount(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deletePosixAccountCallable()
DeleteSshPublicKey	Deletes an SSH public key.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSshPublicKey(DeleteSshPublicKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteSshPublicKey(FingerprintName name) deleteSshPublicKey(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteSshPublicKeyCallable()
GetLoginProfile	Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLoginProfile(GetLoginProfileRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getLoginProfile(UserName name) getLoginProfile(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLoginProfileCallable()
GetSshPublicKey	Retrieves an SSH public key.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSshPublicKey(GetSshPublicKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSshPublicKey(FingerprintName name) getSshPublicKey(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getSshPublicKeyCallable()
ImportSshPublicKey	Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importSshPublicKey(ImportSshPublicKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. importSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey) importSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey) importSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey, String projectId) importSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey, String projectId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importSshPublicKeyCallable()
UpdateSshPublicKey	Updates an SSH public key and returns the profile information. This method supports patch semantics.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateSshPublicKey(UpdateSshPublicKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateSshPublicKey(FingerprintName name, OsLoginProto.SshPublicKey sshPublicKey) updateSshPublicKey(String name, OsLoginProto.SshPublicKey sshPublicKey) updateSshPublicKey(FingerprintName name, OsLoginProto.SshPublicKey sshPublicKey, FieldMask updateMask) updateSshPublicKey(String name, OsLoginProto.SshPublicKey sshPublicKey, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateSshPublicKeyCallable()

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 OsLoginServiceSettings 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
 OsLoginServiceSettings osLoginServiceSettings =
     OsLoginServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create(osLoginServiceSettings);

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
 OsLoginServiceSettings osLoginServiceSettings =
     OsLoginServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create(osLoginServiceSettings);

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
 OsLoginServiceSettings osLoginServiceSettings =
     OsLoginServiceSettings.newHttpJsonBuilder().build();
 OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create(osLoginServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > OsLoginServiceClient

Static Methods

create()

public static final OsLoginServiceClient create()

Constructs an instance of OsLoginServiceClient with default settings.

Returns
Type	Description
`OsLoginServiceClient`

Exceptions
Type	Description
`IOException`

create(OsLoginServiceSettings settings)

public static final OsLoginServiceClient create(OsLoginServiceSettings settings)

Constructs an instance of OsLoginServiceClient, 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`	`OsLoginServiceSettings`

Returns
Type	Description
`OsLoginServiceClient`

Exceptions
Type	Description
`IOException`

create(OsLoginServiceStub stub)

public static final OsLoginServiceClient create(OsLoginServiceStub stub)

Constructs an instance of OsLoginServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(OsLoginServiceSettings).

Parameter
Name	Description
`stub`	`OsLoginServiceStub`

Returns
Type	Description
`OsLoginServiceClient`

Constructors

OsLoginServiceClient(OsLoginServiceSettings settings)

protected OsLoginServiceClient(OsLoginServiceSettings settings)

Constructs an instance of OsLoginServiceClient, 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`	`OsLoginServiceSettings`

OsLoginServiceClient(OsLoginServiceStub stub)

protected OsLoginServiceClient(OsLoginServiceStub stub)

Parameter
Name	Description
`stub`	`OsLoginServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createSshPublicKey(CreateSshPublicKeyRequest request)

public final OsLoginProto.SshPublicKey createSshPublicKey(CreateSshPublicKeyRequest request)

Create an SSH public key

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   CreateSshPublicKeyRequest request =
       CreateSshPublicKeyRequest.newBuilder()
           .setParent(UserName.of("[USER]").toString())
           .setSshPublicKey(OsLoginProto.SshPublicKey.newBuilder().build())
           .build();
   OsLoginProto.SshPublicKey response = osLoginServiceClient.createSshPublicKey(request);
 }

Parameter
Name	Description
`request`	`CreateSshPublicKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

createSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey)

public final OsLoginProto.SshPublicKey createSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey)

Create an SSH public key

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   UserName parent = UserName.of("[USER]");
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   OsLoginProto.SshPublicKey response =
       osLoginServiceClient.createSshPublicKey(parent, sshPublicKey);
 }

Parameters
Name	Description
`parent`	`UserName` Required. The unique ID for the user in format `users/{user}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Required. The SSH public key and expiration time.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

createSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey)

public final OsLoginProto.SshPublicKey createSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey)

Create an SSH public key

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String parent = UserName.of("[USER]").toString();
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   OsLoginProto.SshPublicKey response =
       osLoginServiceClient.createSshPublicKey(parent, sshPublicKey);
 }

Parameters
Name	Description
`parent`	`String` Required. The unique ID for the user in format `users/{user}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Required. The SSH public key and expiration time.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

createSshPublicKeyCallable()

public final UnaryCallable<CreateSshPublicKeyRequest,OsLoginProto.SshPublicKey> createSshPublicKeyCallable()

Create an SSH public key

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   CreateSshPublicKeyRequest request =
       CreateSshPublicKeyRequest.newBuilder()
           .setParent(UserName.of("[USER]").toString())
           .setSshPublicKey(OsLoginProto.SshPublicKey.newBuilder().build())
           .build();
   ApiFuture<OsLoginProto.SshPublicKey> future =
       osLoginServiceClient.createSshPublicKeyCallable().futureCall(request);
   // Do something.
   OsLoginProto.SshPublicKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateSshPublicKeyRequest,SshPublicKey>`

deletePosixAccount(DeletePosixAccountRequest request)

public final void deletePosixAccount(DeletePosixAccountRequest request)

Deletes a POSIX account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   DeletePosixAccountRequest request =
       DeletePosixAccountRequest.newBuilder()
           .setName(ProjectName.of("[USER]", "[PROJECT]").toString())
           .build();
   osLoginServiceClient.deletePosixAccount(request);
 }

Parameter
Name	Description
`request`	`DeletePosixAccountRequest` The request object containing all of the parameters for the API call.

deletePosixAccount(ProjectName name)

public final void deletePosixAccount(ProjectName name)

Deletes a POSIX account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   ProjectName name = ProjectName.of("[USER]", "[PROJECT]");
   osLoginServiceClient.deletePosixAccount(name);
 }

Parameter
Name	Description
`name`	`ProjectName` Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`.

deletePosixAccount(String name)

public final void deletePosixAccount(String name)

Deletes a POSIX account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String name = ProjectName.of("[USER]", "[PROJECT]").toString();
   osLoginServiceClient.deletePosixAccount(name);
 }

Parameter
Name	Description
`name`	`String` Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`.

deletePosixAccountCallable()

public final UnaryCallable<DeletePosixAccountRequest,Empty> deletePosixAccountCallable()

Deletes a POSIX account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   DeletePosixAccountRequest request =
       DeletePosixAccountRequest.newBuilder()
           .setName(ProjectName.of("[USER]", "[PROJECT]").toString())
           .build();
   ApiFuture<Empty> future =
       osLoginServiceClient.deletePosixAccountCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeletePosixAccountRequest,Empty>`

deleteSshPublicKey(DeleteSshPublicKeyRequest request)

public final void deleteSshPublicKey(DeleteSshPublicKeyRequest request)

Deletes an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   DeleteSshPublicKeyRequest request =
       DeleteSshPublicKeyRequest.newBuilder()
           .setName(FingerprintName.of("[USER]", "[FINGERPRINT]").toString())
           .build();
   osLoginServiceClient.deleteSshPublicKey(request);
 }

Parameter
Name	Description
`request`	`DeleteSshPublicKeyRequest` The request object containing all of the parameters for the API call.

deleteSshPublicKey(FingerprintName name)

public final void deleteSshPublicKey(FingerprintName name)

Deletes an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   FingerprintName name = FingerprintName.of("[USER]", "[FINGERPRINT]");
   osLoginServiceClient.deleteSshPublicKey(name);
 }

Parameter
Name	Description
`name`	`FingerprintName` Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.

deleteSshPublicKey(String name)

public final void deleteSshPublicKey(String name)

Deletes an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String name = FingerprintName.of("[USER]", "[FINGERPRINT]").toString();
   osLoginServiceClient.deleteSshPublicKey(name);
 }

Parameter
Name	Description
`name`	`String` Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.

deleteSshPublicKeyCallable()

public final UnaryCallable<DeleteSshPublicKeyRequest,Empty> deleteSshPublicKeyCallable()

Deletes an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   DeleteSshPublicKeyRequest request =
       DeleteSshPublicKeyRequest.newBuilder()
           .setName(FingerprintName.of("[USER]", "[FINGERPRINT]").toString())
           .build();
   ApiFuture<Empty> future =
       osLoginServiceClient.deleteSshPublicKeyCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteSshPublicKeyRequest,Empty>`

getLoginProfile(GetLoginProfileRequest request)

public final LoginProfile getLoginProfile(GetLoginProfileRequest request)

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   GetLoginProfileRequest request =
       GetLoginProfileRequest.newBuilder()
           .setName(UserName.of("[USER]").toString())
           .setProjectId("projectId-894832108")
           .setSystemId("systemId1976085418")
           .build();
   LoginProfile response = osLoginServiceClient.getLoginProfile(request);
 }

Parameter
Name	Description
`request`	`GetLoginProfileRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LoginProfile`

getLoginProfile(UserName name)

public final LoginProfile getLoginProfile(UserName name)

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   UserName name = UserName.of("[USER]");
   LoginProfile response = osLoginServiceClient.getLoginProfile(name);
 }

Parameter
Name	Description
`name`	`UserName` Required. The unique ID for the user in format `users/{user}`.

Returns
Type	Description
`LoginProfile`

getLoginProfile(String name)

public final LoginProfile getLoginProfile(String name)

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String name = UserName.of("[USER]").toString();
   LoginProfile response = osLoginServiceClient.getLoginProfile(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique ID for the user in format `users/{user}`.

Returns
Type	Description
`LoginProfile`

getLoginProfileCallable()

public final UnaryCallable<GetLoginProfileRequest,LoginProfile> getLoginProfileCallable()

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   GetLoginProfileRequest request =
       GetLoginProfileRequest.newBuilder()
           .setName(UserName.of("[USER]").toString())
           .setProjectId("projectId-894832108")
           .setSystemId("systemId1976085418")
           .build();
   ApiFuture<LoginProfile> future =
       osLoginServiceClient.getLoginProfileCallable().futureCall(request);
   // Do something.
   LoginProfile response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetLoginProfileRequest,LoginProfile>`

getSettings()

public final OsLoginServiceSettings getSettings()

Returns
Type	Description
`OsLoginServiceSettings`

getSshPublicKey(FingerprintName name)

public final OsLoginProto.SshPublicKey getSshPublicKey(FingerprintName name)

Retrieves an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   FingerprintName name = FingerprintName.of("[USER]", "[FINGERPRINT]");
   OsLoginProto.SshPublicKey response = osLoginServiceClient.getSshPublicKey(name);
 }

Parameter
Name	Description
`name`	`FingerprintName` Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

getSshPublicKey(GetSshPublicKeyRequest request)

public final OsLoginProto.SshPublicKey getSshPublicKey(GetSshPublicKeyRequest request)

Retrieves an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   GetSshPublicKeyRequest request =
       GetSshPublicKeyRequest.newBuilder()
           .setName(FingerprintName.of("[USER]", "[FINGERPRINT]").toString())
           .build();
   OsLoginProto.SshPublicKey response = osLoginServiceClient.getSshPublicKey(request);
 }

Parameter
Name	Description
`request`	`GetSshPublicKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

getSshPublicKey(String name)

public final OsLoginProto.SshPublicKey getSshPublicKey(String name)

Retrieves an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String name = FingerprintName.of("[USER]", "[FINGERPRINT]").toString();
   OsLoginProto.SshPublicKey response = osLoginServiceClient.getSshPublicKey(name);
 }

Parameter
Name	Description
`name`	`String` Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

getSshPublicKeyCallable()

public final UnaryCallable<GetSshPublicKeyRequest,OsLoginProto.SshPublicKey> getSshPublicKeyCallable()

Retrieves an SSH public key.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   GetSshPublicKeyRequest request =
       GetSshPublicKeyRequest.newBuilder()
           .setName(FingerprintName.of("[USER]", "[FINGERPRINT]").toString())
           .build();
   ApiFuture<OsLoginProto.SshPublicKey> future =
       osLoginServiceClient.getSshPublicKeyCallable().futureCall(request);
   // Do something.
   OsLoginProto.SshPublicKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetSshPublicKeyRequest,SshPublicKey>`

getStub()

public OsLoginServiceStub getStub()

Returns
Type	Description
`OsLoginServiceStub`

importSshPublicKey(ImportSshPublicKeyRequest request)

public final ImportSshPublicKeyResponse importSshPublicKey(ImportSshPublicKeyRequest request)

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   ImportSshPublicKeyRequest request =
       ImportSshPublicKeyRequest.newBuilder()
           .setParent(UserName.of("[USER]").toString())
           .setSshPublicKey(OsLoginProto.SshPublicKey.newBuilder().build())
           .setProjectId("projectId-894832108")
           .addAllRegions(new ArrayList<String>())
           .build();
   ImportSshPublicKeyResponse response = osLoginServiceClient.importSshPublicKey(request);
 }

Parameter
Name	Description
`request`	`ImportSshPublicKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ImportSshPublicKeyResponse`

importSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey)

public final ImportSshPublicKeyResponse importSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey)

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   UserName parent = UserName.of("[USER]");
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   ImportSshPublicKeyResponse response =
       osLoginServiceClient.importSshPublicKey(parent, sshPublicKey);
 }

Parameters
Name	Description
`parent`	`UserName` Required. The unique ID for the user in format `users/{user}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Optional. The SSH public key and expiration time.

Returns
Type	Description
`ImportSshPublicKeyResponse`

importSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey, String projectId)

public final ImportSshPublicKeyResponse importSshPublicKey(UserName parent, OsLoginProto.SshPublicKey sshPublicKey, String projectId)

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   UserName parent = UserName.of("[USER]");
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   String projectId = "projectId-894832108";
   ImportSshPublicKeyResponse response =
       osLoginServiceClient.importSshPublicKey(parent, sshPublicKey, projectId);
 }

Parameters
Name	Description
`parent`	`UserName` Required. The unique ID for the user in format `users/{user}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Optional. The SSH public key and expiration time.
`projectId`	`String` The project ID of the Google Cloud Platform project.

Returns
Type	Description
`ImportSshPublicKeyResponse`

importSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey)

public final ImportSshPublicKeyResponse importSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey)

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String parent = UserName.of("[USER]").toString();
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   ImportSshPublicKeyResponse response =
       osLoginServiceClient.importSshPublicKey(parent, sshPublicKey);
 }

Parameters
Name	Description
`parent`	`String` Required. The unique ID for the user in format `users/{user}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Optional. The SSH public key and expiration time.

Returns
Type	Description
`ImportSshPublicKeyResponse`

importSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey, String projectId)

public final ImportSshPublicKeyResponse importSshPublicKey(String parent, OsLoginProto.SshPublicKey sshPublicKey, String projectId)

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String parent = UserName.of("[USER]").toString();
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   String projectId = "projectId-894832108";
   ImportSshPublicKeyResponse response =
       osLoginServiceClient.importSshPublicKey(parent, sshPublicKey, projectId);
 }

Parameters
Name	Description
`parent`	`String` Required. The unique ID for the user in format `users/{user}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Optional. The SSH public key and expiration time.
`projectId`	`String` The project ID of the Google Cloud Platform project.

Returns
Type	Description
`ImportSshPublicKeyResponse`

importSshPublicKeyCallable()

public final UnaryCallable<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse> importSshPublicKeyCallable()

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   ImportSshPublicKeyRequest request =
       ImportSshPublicKeyRequest.newBuilder()
           .setParent(UserName.of("[USER]").toString())
           .setSshPublicKey(OsLoginProto.SshPublicKey.newBuilder().build())
           .setProjectId("projectId-894832108")
           .addAllRegions(new ArrayList<String>())
           .build();
   ApiFuture<ImportSshPublicKeyResponse> future =
       osLoginServiceClient.importSshPublicKeyCallable().futureCall(request);
   // Do something.
   ImportSshPublicKeyResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateSshPublicKey(FingerprintName name, OsLoginProto.SshPublicKey sshPublicKey)

public final OsLoginProto.SshPublicKey updateSshPublicKey(FingerprintName name, OsLoginProto.SshPublicKey sshPublicKey)

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   FingerprintName name = FingerprintName.of("[USER]", "[FINGERPRINT]");
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   OsLoginProto.SshPublicKey response =
       osLoginServiceClient.updateSshPublicKey(name, sshPublicKey);
 }

Parameters
Name	Description
`name`	`FingerprintName` Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Required. The SSH public key and expiration time.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

updateSshPublicKey(FingerprintName name, OsLoginProto.SshPublicKey sshPublicKey, FieldMask updateMask)

public final OsLoginProto.SshPublicKey updateSshPublicKey(FingerprintName name, OsLoginProto.SshPublicKey sshPublicKey, FieldMask updateMask)

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   FingerprintName name = FingerprintName.of("[USER]", "[FINGERPRINT]");
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   OsLoginProto.SshPublicKey response =
       osLoginServiceClient.updateSshPublicKey(name, sshPublicKey, updateMask);
 }

Parameters
Name	Description
`name`	`FingerprintName` Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Required. The SSH public key and expiration time.
`updateMask`	`FieldMask` Mask to control which fields get updated. Updates all if not present.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

updateSshPublicKey(UpdateSshPublicKeyRequest request)

public final OsLoginProto.SshPublicKey updateSshPublicKey(UpdateSshPublicKeyRequest request)

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   UpdateSshPublicKeyRequest request =
       UpdateSshPublicKeyRequest.newBuilder()
           .setName(FingerprintName.of("[USER]", "[FINGERPRINT]").toString())
           .setSshPublicKey(OsLoginProto.SshPublicKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OsLoginProto.SshPublicKey response = osLoginServiceClient.updateSshPublicKey(request);
 }

Parameter
Name	Description
`request`	`UpdateSshPublicKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

updateSshPublicKey(String name, OsLoginProto.SshPublicKey sshPublicKey)

public final OsLoginProto.SshPublicKey updateSshPublicKey(String name, OsLoginProto.SshPublicKey sshPublicKey)

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String name = FingerprintName.of("[USER]", "[FINGERPRINT]").toString();
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   OsLoginProto.SshPublicKey response =
       osLoginServiceClient.updateSshPublicKey(name, sshPublicKey);
 }

Parameters
Name	Description
`name`	`String` Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Required. The SSH public key and expiration time.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

updateSshPublicKey(String name, OsLoginProto.SshPublicKey sshPublicKey, FieldMask updateMask)

public final OsLoginProto.SshPublicKey updateSshPublicKey(String name, OsLoginProto.SshPublicKey sshPublicKey, FieldMask updateMask)

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   String name = FingerprintName.of("[USER]", "[FINGERPRINT]").toString();
   OsLoginProto.SshPublicKey sshPublicKey = OsLoginProto.SshPublicKey.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   OsLoginProto.SshPublicKey response =
       osLoginServiceClient.updateSshPublicKey(name, sshPublicKey, updateMask);
 }

Parameters
Name	Description
`name`	`String` Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.
`sshPublicKey`	`OsLoginProto.SshPublicKey` Required. The SSH public key and expiration time.
`updateMask`	`FieldMask` Mask to control which fields get updated. Updates all if not present.

Returns
Type	Description
`OsLoginProto.SshPublicKey`

updateSshPublicKeyCallable()

public final UnaryCallable<UpdateSshPublicKeyRequest,OsLoginProto.SshPublicKey> updateSshPublicKeyCallable()

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OsLoginServiceClient osLoginServiceClient = OsLoginServiceClient.create()) {
   UpdateSshPublicKeyRequest request =
       UpdateSshPublicKeyRequest.newBuilder()
           .setName(FingerprintName.of("[USER]", "[FINGERPRINT]").toString())
           .setSshPublicKey(OsLoginProto.SshPublicKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<OsLoginProto.SshPublicKey> future =
       osLoginServiceClient.updateSshPublicKeyCallable().futureCall(request);
   // Do something.
   OsLoginProto.SshPublicKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateSshPublicKeyRequest,SshPublicKey>`