Package com.google.cloud.bigtable.admin.v2.models

Class CreateAppProfileRequest

java.lang.Object

com.google.cloud.bigtable.admin.v2.models.CreateAppProfileRequest

public final class CreateAppProfileRequest
extends Object

Parameters for creating a new Cloud Bigtable app profile.

An application profile, or app profile, stores settings that tell your Cloud Bigtable instance how to handle incoming requests from an application. When one of your applications connects to a Cloud Bigtable instance, it can specify an app profile, and Cloud Bigtable uses that app profile for any requests that the application sends over that connection.

Sample code:

 AppProfile existingAppProfile = ...;
 CreateAppProfileRequest appProfileRequest = CreateAppProfileRequest.of("my-instance", "my-new-app-profile")
   .setRoutingPolicy(SingleClusterRoutingPolicy.of("my-cluster"));
 

See Also:

for more details

Method Summary

Modifier and Type	Method	Description
static CreateAppProfileRequest	of(String instanceId, String appProfileId)	Builds a new request to create a new app profile in the specified instance.
CreateAppProfileRequest	setDescription(String description)	Sets the optional long form description of the use case for the AppProfile.
CreateAppProfileRequest	setIgnoreWarnings(boolean value)	Configures if safety warnings should be disabled.
CreateAppProfileRequest	setRoutingPolicy(AppProfile.RoutingPolicy routingPolicy)	Sets the routing policy for all read/write requests that use this app profile.
CreateAppProfileRequest	toProto(String projectId)	Creates the request protobuf.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static CreateAppProfileRequest of(String instanceId,
                                         String appProfileId)

Builds a new request to create a new app profile in the specified instance.

setIgnoreWarnings

public CreateAppProfileRequest setIgnoreWarnings(boolean value)

Configures if safety warnings should be disabled.

setDescription

public CreateAppProfileRequest setDescription(@Nonnull
                                              String description)

Sets the optional long form description of the use case for the AppProfile.

setRoutingPolicy

public CreateAppProfileRequest setRoutingPolicy(AppProfile.RoutingPolicy routingPolicy)

Sets the routing policy for all read/write requests that use this app profile.

toProto

@InternalApi
public CreateAppProfileRequest toProto(String projectId)

Creates the request protobuf. This method is considered an internal implementation detail and not meant to be used by applications.