Class CreateAppProfileRequest (2.20.1)

public final class CreateAppProfileRequest

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"));

Inheritance

java.lang.Object > CreateAppProfileRequest

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

of(String instanceId, String appProfileId)

public static CreateAppProfileRequest of(String instanceId, String appProfileId)

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

Parameters
Name	Description
`instanceId`	`String`
`appProfileId`	`String`

Returns
Type	Description
`CreateAppProfileRequest`

Methods

setDescription(String description)

public CreateAppProfileRequest setDescription(String description)

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

Parameter
Name	Description
`description`	`String`

Returns
Type	Description
`CreateAppProfileRequest`

setIgnoreWarnings(boolean value)

public CreateAppProfileRequest setIgnoreWarnings(boolean value)

Configures if safety warnings should be disabled.

Parameter
Name	Description
`value`	`boolean`

Returns
Type	Description
`CreateAppProfileRequest`

setRoutingPolicy(AppProfile.RoutingPolicy routingPolicy)

public CreateAppProfileRequest setRoutingPolicy(AppProfile.RoutingPolicy routingPolicy)

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

Parameter
Name	Description
`routingPolicy`	`AppProfile.RoutingPolicy`

Returns
Type	Description
`CreateAppProfileRequest`

toProto(String projectId)

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.

Parameter
Name	Description
`projectId`	`String`

Returns
Type	Description
`com.google.bigtable.admin.v2.CreateAppProfileRequest`