Class UpdateAppProfileRequest (2.28.0)

public final class UpdateAppProfileRequest

Parameters for updating an existing Cloud Bigtable app profile.

Examples


 AppProfile existingAppProfile = ...;
 UpdateAppProfileRequest appProfileRequest = UpdateAppProfileRequest.of(existingAppProfile)
   .setRoutingPolicy(SingleClusterRoutingPolicy.of("my-cluster"));

Inheritance

Object > UpdateAppProfileRequest

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(AppProfile appProfile)

public static UpdateAppProfileRequest of(AppProfile appProfile)

Builds a new update request using an existing AppProfile.

This variant is recommended over #of(String, String) because it provides optimistic concurrency control using etags.

Parameter
Name	Description
`appProfile`	`AppProfile`

Returns
Type	Description
`UpdateAppProfileRequest`

of(String instanceId, String appProfileId)

public static UpdateAppProfileRequest of(String instanceId, String appProfileId)

Builds a new update request using an existing AppProfile.

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

Returns
Type	Description
`UpdateAppProfileRequest`

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
`o`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

setDescription(String description)

public UpdateAppProfileRequest setDescription(String description)

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

Parameter
Name	Description
`description`	`String`

Returns
Type	Description
`UpdateAppProfileRequest`

setIgnoreWarnings(boolean value)

public UpdateAppProfileRequest setIgnoreWarnings(boolean value)

Configures if safety warnings should be disabled.

Parameter
Name	Description
`value`	`boolean`

Returns
Type	Description
`UpdateAppProfileRequest`

setRoutingPolicy(AppProfile.RoutingPolicy routingPolicy)

public UpdateAppProfileRequest 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
`UpdateAppProfileRequest`

toProto(String projectId)

public UpdateAppProfileRequest 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.UpdateAppProfileRequest`