Class CreateInstanceRequestBuilder (2.39.0)
This is useful when calling the InstanceAdminClient::CreateInstance()
function.
Example
void CreateInstance(google::cloud::spanner_admin::InstanceAdminClient client,
std::string const& project_id,
std::string const& instance_id,
std::string const& display_name,
std::string const& config_id) {
namespace spanner = ::google::cloud::spanner;
spanner::Instance in(project_id, instance_id);
auto project = google::cloud::Project(project_id);
std::string config_name =
project.FullName() + "/instanceConfigs/" + config_id;
auto instance =
client
.CreateInstance(spanner::CreateInstanceRequestBuilder(in, config_name)
.SetDisplayName(display_name)
.SetNodeCount(1)
.SetLabels({{"cloud_spanner_samples", "true"}})
.Build())
.get();
if (!instance) throw std::move(instance).status();
std::cout << "Created instance [" << in << "]:\n" << instance->DebugString();
}
Constructors
CreateInstanceRequestBuilder(CreateInstanceRequestBuilder const &)
Parameter |
Name |
Description |
|
CreateInstanceRequestBuilder const &
|
CreateInstanceRequestBuilder(CreateInstanceRequestBuilder &&)
Parameter |
Name |
Description |
|
CreateInstanceRequestBuilder &&
|
CreateInstanceRequestBuilder(Instance const &, std::string)
Constructor requires Instance and Cloud Spanner instance config name.
The display_name is set to a default value of in.instance_id().
Parameters |
Name |
Description |
in |
Instance const &
|
config |
std::string
|
Operators
operator=(CreateInstanceRequestBuilder const &)
Parameter |
Name |
Description |
|
CreateInstanceRequestBuilder const &
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder & |
|
operator=(CreateInstanceRequestBuilder &&)
Parameter |
Name |
Description |
|
CreateInstanceRequestBuilder &&
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder & |
|
Functions
SetDisplayName(std::string) &
Parameter |
Name |
Description |
display_name |
std::string
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder & |
|
SetDisplayName(std::string) &&
Parameter |
Name |
Description |
display_name |
std::string
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder && |
|
SetNodeCount(int) &
Parameter |
Name |
Description |
node_count |
int
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder & |
|
SetNodeCount(int) &&
Parameter |
Name |
Description |
node_count |
int
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder && |
|
SetProcessingUnits(int) &
Parameter |
Name |
Description |
processing_units |
int
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder & |
|
SetProcessingUnits(int) &&
Parameter |
Name |
Description |
processing_units |
int
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder && |
|
SetLabels(std::map< std::string, std::string > const &) &
Parameter |
Name |
Description |
labels |
std::map< std::string, std::string > const &
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder & |
|
SetLabels(std::map< std::string, std::string > const &) &&
Parameter |
Name |
Description |
labels |
std::map< std::string, std::string > const &
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder && |
|
SetEdition(Edition) &
Parameter |
Name |
Description |
edition |
Edition
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder & |
|
SetEdition(Edition) &&
Parameter |
Name |
Description |
edition |
Edition
|
Returns |
Type |
Description |
CreateInstanceRequestBuilder && |
|
Build() &
Returns |
Type |
Description |
google::spanner::admin::instance::v1::CreateInstanceRequest & |
|
Build() &&
Returns |
Type |
Description |
google::spanner::admin::instance::v1::CreateInstanceRequest && |
|
google::cloud::spanner::CreateInstanceRequestBuilder::Edition
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[],[],null,["# Class CreateInstanceRequestBuilder (2.39.0)\n\nVersion 2.39.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/spanner/latest/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.41.0](/cpp/docs/reference/spanner/2.41.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.40.0](/cpp/docs/reference/spanner/2.40.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.39.0](/cpp/docs/reference/spanner/2.39.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.38.0](/cpp/docs/reference/spanner/2.38.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.37.0](/cpp/docs/reference/spanner/2.37.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.36.0](/cpp/docs/reference/spanner/2.36.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.35.0](/cpp/docs/reference/spanner/2.35.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.34.0](/cpp/docs/reference/spanner/2.34.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.33.0](/cpp/docs/reference/spanner/2.33.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.32.0](/cpp/docs/reference/spanner/2.32.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.31.0](/cpp/docs/reference/spanner/2.31.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.30.0](/cpp/docs/reference/spanner/2.30.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.29.0](/cpp/docs/reference/spanner/2.29.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.28.0](/cpp/docs/reference/spanner/2.28.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.27.0](/cpp/docs/reference/spanner/2.27.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.26.0](/cpp/docs/reference/spanner/2.26.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.25.1](/cpp/docs/reference/spanner/2.25.1/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.24.0](/cpp/docs/reference/spanner/2.24.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.23.0](/cpp/docs/reference/spanner/2.23.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.22.1](/cpp/docs/reference/spanner/2.22.1/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.21.0](/cpp/docs/reference/spanner/2.21.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.20.0](/cpp/docs/reference/spanner/2.20.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.19.0](/cpp/docs/reference/spanner/2.19.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.18.0](/cpp/docs/reference/spanner/2.18.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.17.0](/cpp/docs/reference/spanner/2.17.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.16.0](/cpp/docs/reference/spanner/2.16.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.15.1](/cpp/docs/reference/spanner/2.15.1/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.14.0](/cpp/docs/reference/spanner/2.14.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.13.0](/cpp/docs/reference/spanner/2.13.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.12.0](/cpp/docs/reference/spanner/2.12.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder)\n- [2.11.0](/cpp/docs/reference/spanner/2.11.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder) \n[CreateInstanceRequestBuilder](/cpp/docs/reference/spanner/2.39.0/classgoogle_1_1cloud_1_1spanner_1_1CreateInstanceRequestBuilder) is a builder class for `google::spanner::admin::instance::v1::CreateInstanceRequest` \nThis is useful when calling the [`InstanceAdminClient::CreateInstance()`](/cpp/docs/reference/spanner/2.39.0/classgoogle_1_1cloud_1_1spanner_1_1InstanceAdminClient#classgoogle_1_1cloud_1_1spanner_1_1InstanceAdminClient_1a5e4fb3bd8cfd7df335a0e75dd3e0bc47) function.\n\n###### Example\n\n void CreateInstance(google::cloud::spanner_admin::InstanceAdminClient client,\n std::string const& project_id,\n std::string const& instance_id,\n std::string const& display_name,\n std::string const& config_id) {\n namespace spanner = ::google::cloud::spanner;\n spanner::Instance in(project_id, instance_id);\n\n auto project = google::cloud::Project(project_id);\n std::string config_name =\n project.FullName() + \"/instanceConfigs/\" + config_id;\n auto instance =\n client\n .CreateInstance(spanner::CreateInstanceRequestBuilder(in, config_name)\n .SetDisplayName(display_name)\n .SetNodeCount(1)\n .SetLabels({{\"cloud_spanner_samples\", \"true\"}})\n .Build())\n .get();\n if (!instance) throw std::move(instance).status();\n std::cout \u003c\u003c \"Created instance [\" \u003c\u003c in \u003c\u003c \"]:\\n\" \u003c\u003c instance-\u003eDebugString();\n }\n\nConstructors\n------------\n\n### CreateInstanceRequestBuilder(CreateInstanceRequestBuilder const \\&)\n\n### CreateInstanceRequestBuilder(CreateInstanceRequestBuilder \\&\\&)\n\n### CreateInstanceRequestBuilder(Instance const \\&, std::string)\n\nConstructor requires [Instance](/cpp/docs/reference/spanner/2.39.0/classgoogle_1_1cloud_1_1spanner_1_1Instance) and Cloud Spanner instance config name. \nThe display_name is set to a default value of in.instance_id().\n\nOperators\n---------\n\n### operator=(CreateInstanceRequestBuilder const \\&)\n\n### operator=(CreateInstanceRequestBuilder \\&\\&)\n\nFunctions\n---------\n\n### SetDisplayName(std::string) \\&\n\n### SetDisplayName(std::string) \\&\\&\n\n### SetNodeCount(int) \\&\n\n### SetNodeCount(int) \\&\\&\n\n### SetProcessingUnits(int) \\&\n\n### SetProcessingUnits(int) \\&\\&\n\n### SetLabels(std::map\\\u003c std::string, std::string \\\u003e const \\&) \\&\n\n### SetLabels(std::map\\\u003c std::string, std::string \\\u003e const \\&) \\&\\&\n\n### SetEdition(Edition) \\&\n\n### SetEdition(Edition) \\&\\&\n\n### Build() \\&\n\n### Build() \\&\\&\n\n### google::cloud::spanner::CreateInstanceRequestBuilder::Edition"]]