ProfileServiceClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.talent.v4beta1.ProfileServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class ProfileServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: A service that handles profile management, including profile CRUD, enumeration and search.
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:
```
 
 try (ProfileServiceClient profileServiceClient = ProfileServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Profile profile = Profile.newBuilder().build();
   Profile response = profileServiceClient.createProfile(parent, profile);
 }
 
 
```
Note: close() needs to be called on the profileServiceClient 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:
1. 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.
2. 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.
3. 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 ProfileServiceSettings to create(). For example:
To customize credentials:
```
 
 ProfileServiceSettings profileServiceSettings =
     ProfileServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProfileServiceClient profileServiceClient =
     ProfileServiceClient.create(profileServiceSettings);
 
 
```
To customize the endpoint:
```
 
 ProfileServiceSettings profileServiceSettings =
     ProfileServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProfileServiceClient profileServiceClient =
     ProfileServiceClient.create(profileServiceSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProfileServiceClient.ListProfilesFixedSizeCollection`
`static class`	`ProfileServiceClient.ListProfilesPage`
`static class`	`ProfileServiceClient.ListProfilesPagedResponse`
`static class`	`ProfileServiceClient.SearchProfilesFixedSizeCollection`
`static class`	`ProfileServiceClient.SearchProfilesPage`
`static class`	`ProfileServiceClient.SearchProfilesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ProfileServiceClient(ProfileServiceSettings settings)` Constructs an instance of ProfileServiceClient, using the given settings.
`protected`	`ProfileServiceClient(ProfileServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ProfileServiceClient`	`create()` Constructs an instance of ProfileServiceClient with default settings.
`static ProfileServiceClient`	`create(ProfileServiceSettings settings)` Constructs an instance of ProfileServiceClient, using the given settings.
`static ProfileServiceClient`	`create(ProfileServiceStub stub)` Constructs an instance of ProfileServiceClient, using the given stub for making calls.
`Profile`	`createProfile(CreateProfileRequest request)` Creates and returns a new profile.
`Profile`	`createProfile(String parent, Profile profile)` Creates and returns a new profile.
`Profile`	`createProfile(TenantName parent, Profile profile)` Creates and returns a new profile.
`com.google.api.gax.rpc.UnaryCallable<CreateProfileRequest,Profile>`	`createProfileCallable()` Creates and returns a new profile.
`void`	`deleteProfile(DeleteProfileRequest request)` Deletes the specified profile.
`void`	`deleteProfile(ProfileName name)` Deletes the specified profile.
`void`	`deleteProfile(String name)` Deletes the specified profile.
`com.google.api.gax.rpc.UnaryCallable<DeleteProfileRequest,Empty>`	`deleteProfileCallable()` Deletes the specified profile.
`Profile`	`getProfile(GetProfileRequest request)` Gets the specified profile.
`Profile`	`getProfile(ProfileName name)` Gets the specified profile.
`Profile`	`getProfile(String name)` Gets the specified profile.
`com.google.api.gax.rpc.UnaryCallable<GetProfileRequest,Profile>`	`getProfileCallable()` Gets the specified profile.
`ProfileServiceSettings`	`getSettings()`
`ProfileServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ProfileServiceClient.ListProfilesPagedResponse`	`listProfiles(ListProfilesRequest request)` Lists profiles by filter.
`ProfileServiceClient.ListProfilesPagedResponse`	`listProfiles(String parent)` Lists profiles by filter.
`ProfileServiceClient.ListProfilesPagedResponse`	`listProfiles(TenantName parent)` Lists profiles by filter.
`com.google.api.gax.rpc.UnaryCallable<ListProfilesRequest,ListProfilesResponse>`	`listProfilesCallable()` Lists profiles by filter.
`com.google.api.gax.rpc.UnaryCallable<ListProfilesRequest,ProfileServiceClient.ListProfilesPagedResponse>`	`listProfilesPagedCallable()` Lists profiles by filter.
`ProfileServiceClient.SearchProfilesPagedResponse`	`searchProfiles(SearchProfilesRequest request)` Searches for profiles within a tenant.
`com.google.api.gax.rpc.UnaryCallable<SearchProfilesRequest,SearchProfilesResponse>`	`searchProfilesCallable()` Searches for profiles within a tenant.
`com.google.api.gax.rpc.UnaryCallable<SearchProfilesRequest,ProfileServiceClient.SearchProfilesPagedResponse>`	`searchProfilesPagedCallable()` Searches for profiles within a tenant.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Profile`	`updateProfile(Profile profile)` Updates the specified profile and returns the updated result.
`Profile`	`updateProfile(UpdateProfileRequest request)` Updates the specified profile and returns the updated result.
`com.google.api.gax.rpc.UnaryCallable<UpdateProfileRequest,Profile>`	`updateProfileCallable()` Updates the specified profile and returns the updated result.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ProfileServiceClient
```
protected ProfileServiceClient(ProfileServiceSettings settings)
                        throws IOException
```
  Constructs an instance of ProfileServiceClient, 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.
  
  Throws:
  
  IOException
- ProfileServiceClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ProfileServiceClient(ProfileServiceStub stub)
```

Method Detail

create

public static final ProfileServiceClient create()
                                         throws IOException

Constructs an instance of ProfileServiceClient with default settings.

Throws:: IOException

create
```
public static final ProfileServiceClient create(ProfileServiceSettings settings)
                                         throws IOException
```
Constructs an instance of ProfileServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final ProfileServiceClient create(ProfileServiceStub stub)

Constructs an instance of ProfileServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use ProfileServiceSettings}.

getSettings

public final ProfileServiceSettings getSettings()