Class CreateInstanceRequest (2.17.1)

public final class CreateInstanceRequest extends GeneratedMessageV3 implements CreateInstanceRequestOrBuilder

Request message for BigtableInstanceAdmin.CreateInstance.

Protobuf type google.bigtable.admin.v2.CreateInstanceRequest

Static Fields

CLUSTERS_FIELD_NUMBER

public static final int CLUSTERS_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_ID_FIELD_NUMBER

public static final int INSTANCE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateInstanceRequest getDefaultInstance()
Returns
TypeDescription
CreateInstanceRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateInstanceRequest.Builder newBuilder()
Returns
TypeDescription
CreateInstanceRequest.Builder

newBuilder(CreateInstanceRequest prototype)

public static CreateInstanceRequest.Builder newBuilder(CreateInstanceRequest prototype)
Parameter
NameDescription
prototypeCreateInstanceRequest
Returns
TypeDescription
CreateInstanceRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateInstanceRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateInstanceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateInstanceRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateInstanceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateInstanceRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateInstanceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateInstanceRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateInstanceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateInstanceRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateInstanceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateInstanceRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateInstanceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateInstanceRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateInstanceRequest> parser()
Returns
TypeDescription
Parser<CreateInstanceRequest>

Methods

containsClusters(String key)

public boolean containsClusters(String key)

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

map<string, .google.bigtable.admin.v2.Cluster> clusters = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getClusters()

public Map<String,Cluster> getClusters()

Use #getClustersMap() instead.

Returns
TypeDescription
Map<String,Cluster>

getClustersCount()

public int getClustersCount()

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

map<string, .google.bigtable.admin.v2.Cluster> clusters = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getClustersMap()

public Map<String,Cluster> getClustersMap()

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

map<string, .google.bigtable.admin.v2.Cluster> clusters = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Map<String,Cluster>

getClustersOrDefault(String key, Cluster defaultValue)

public Cluster getClustersOrDefault(String key, Cluster defaultValue)

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

map<string, .google.bigtable.admin.v2.Cluster> clusters = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
keyString
defaultValueCluster
Returns
TypeDescription
Cluster

getClustersOrThrow(String key)

public Cluster getClustersOrThrow(String key)

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

map<string, .google.bigtable.admin.v2.Cluster> clusters = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
keyString
Returns
TypeDescription
Cluster

getDefaultInstanceForType()

public CreateInstanceRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateInstanceRequest

getInstance()

public Instance getInstance()

Required. The instance to create. Fields marked OutputOnly must be left blank.

.google.bigtable.admin.v2.Instance instance = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Instance

The instance.

getInstanceId()

public String getInstanceId()

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

string instance_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The instanceId.

getInstanceIdBytes()

public ByteString getInstanceIdBytes()

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

string instance_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for instanceId.

getInstanceOrBuilder()

public InstanceOrBuilder getInstanceOrBuilder()

Required. The instance to create. Fields marked OutputOnly must be left blank.

.google.bigtable.admin.v2.Instance instance = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
InstanceOrBuilder

getParent()

public String getParent()

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateInstanceRequest> getParserForType()
Returns
TypeDescription
Parser<CreateInstanceRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasInstance()

public boolean hasInstance()

Required. The instance to create. Fields marked OutputOnly must be left blank.

.google.bigtable.admin.v2.Instance instance = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the instance field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateInstanceRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateInstanceRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateInstanceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateInstanceRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateInstanceRequest.Builder toBuilder()
Returns
TypeDescription
CreateInstanceRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException