Blame - docs/dyn/baremetalsolution_v1alpha1.projects.locations.html - platform/external/python/google-api-python-client

blob: 4fea5ec5527bd9cf938999d796647a3ed68af857 [file] [log] [blame]

yoshi-code-bot	a933dad	2021-07-06 00:26:24 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="baremetalsolution_v1alpha1.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v1alpha1.projects.html">projects</a> . <a href="baremetalsolution_v1alpha1.projects.locations.html">locations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="baremetalsolution_v1alpha1.projects.locations.instances.html">instances()</a></code>
				79	</p>
				80	<p class="firstline">Returns the instances Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="baremetalsolution_v1alpha1.projects.locations.luns.html">luns()</a></code>
				84	</p>
				85	<p class="firstline">Returns the luns Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="baremetalsolution_v1alpha1.projects.locations.volumes.html">volumes()</a></code>
				89	</p>
				90	<p class="firstline">Returns the volumes Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="#close">close()</a></code></p>
				94	<p class="firstline">Close httplib2 connections.</p>
				95	<p class="toc_element">
				96	<code><a href="#submitProvisioningConfig">submitProvisioningConfig(project, location, body=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Submit a provisiong configuration for a given project.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
				105	<code class="details" id="submitProvisioningConfig">submitProvisioningConfig(project, location, body=None, x__xgafv=None)</code>
				106	<pre>Submit a provisiong configuration for a given project.
				107
				108	Args:
				109	project: string, Required. The target project of the provisioning request. (required)
				110	location: string, Required. The target location of the provisioning request. (required)
				111	body: object, The request body.
				112	The object takes the form of:
				113
				114	{ # Request for SubmitProvisioningConfig.
				115	"provisioningConfig": { # An provisioning configuration. # Required. The ProvisioningConfig to submit.
				116	"instances": [ # Instances to be created.
				117	{ # Configuration parameters for a new instance.
				118	"clientNetwork": { # A network. # Client network address.
				119	"address": "A String", # IP address to be assigned to the server.
				120	"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
				121	},
				122	"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
				123	"id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request.
				124	"instanceType": "A String", # Instance type.
				125	"location": "A String", # Location where to deploy the instance.
				126	"osImage": "A String", # OS image to initialize the instance.
				127	"privateNetwork": { # A network. # Private network address, if any.
				128	"address": "A String", # IP address to be assigned to the server.
				129	"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
				130	},
				131	},
				132	],
				133	"networks": [ # Networks to be created.
				134	{ # Configuration parameters for a new network.
				135	"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
				136	"cidr": "A String", # CIDR range of the network.
				137	"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
				138	"location": "A String", # Location where to deploy the network.
				139	"serviceCidr": "A String", # Service CIDR, if any.
				140	"type": "A String", # The type of this network.
				141	"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).
				142	{ # A GCP vlan attachment.
				143	"id": "A String", # Identifier of the VLAN attachment.
				144	"pairingKey": "A String", # Attachment pairing key.
				145	},
				146	],
				147	},
				148	],
				149	"ticketId": "A String", # A reference to track the request.
				150	"volumes": [ # Volumes to be created.
				151	{ # Configuration parameters for a new volume.
				152	"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
				153	"location": "A String", # Location where to deploy the volume.
				154	"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
				155	{ # A LUN range.
				156	"quantity": 42, # Number of LUNs to create.
				157	"sizeGb": 42, # The requested size of each LUN, in GB.
				158	},
				159	],
				160	"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
				161	"A String",
				162	],
				163	"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
				164	{ # A NFS export entry.
				165	"allowDev": True or False, # Allow dev.
				166	"allowSuid": True or False, # Allow the setuid flag.
				167	"cidr": "A String", # A CIDR range.
				168	"machineId": "A String", # A single machine, identified by an ID.
				169	"networkId": "A String", # Network to use to publish the export.
				170	"noRootSquash": True or False, # Disable root squashing.
				171	"permissions": "A String", # Export permissions.
				172	},
				173	],
				174	"protocol": "A String", # Volume protocol.
				175	"sizeGb": 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field.
				176	"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
				177	"type": "A String", # The type of this Volume.
				178	},
				179	],
				180	},
				181	}
				182
				183	x__xgafv: string, V1 error format.
				184	Allowed values
				185	1 - v1 error format
				186	2 - v2 error format
				187
				188	Returns:
				189	An object of the form:
				190
				191	{ # An provisioning configuration.
				192	"instances": [ # Instances to be created.
				193	{ # Configuration parameters for a new instance.
				194	"clientNetwork": { # A network. # Client network address.
				195	"address": "A String", # IP address to be assigned to the server.
				196	"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
				197	},
				198	"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
				199	"id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request.
				200	"instanceType": "A String", # Instance type.
				201	"location": "A String", # Location where to deploy the instance.
				202	"osImage": "A String", # OS image to initialize the instance.
				203	"privateNetwork": { # A network. # Private network address, if any.
				204	"address": "A String", # IP address to be assigned to the server.
				205	"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
				206	},
				207	},
				208	],
				209	"networks": [ # Networks to be created.
				210	{ # Configuration parameters for a new network.
				211	"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
				212	"cidr": "A String", # CIDR range of the network.
				213	"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
				214	"location": "A String", # Location where to deploy the network.
				215	"serviceCidr": "A String", # Service CIDR, if any.
				216	"type": "A String", # The type of this network.
				217	"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).
				218	{ # A GCP vlan attachment.
				219	"id": "A String", # Identifier of the VLAN attachment.
				220	"pairingKey": "A String", # Attachment pairing key.
				221	},
				222	],
				223	},
				224	],
				225	"ticketId": "A String", # A reference to track the request.
				226	"volumes": [ # Volumes to be created.
				227	{ # Configuration parameters for a new volume.
				228	"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
				229	"location": "A String", # Location where to deploy the volume.
				230	"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
				231	{ # A LUN range.
				232	"quantity": 42, # Number of LUNs to create.
				233	"sizeGb": 42, # The requested size of each LUN, in GB.
				234	},
				235	],
				236	"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
				237	"A String",
				238	],
				239	"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
				240	{ # A NFS export entry.
				241	"allowDev": True or False, # Allow dev.
				242	"allowSuid": True or False, # Allow the setuid flag.
				243	"cidr": "A String", # A CIDR range.
				244	"machineId": "A String", # A single machine, identified by an ID.
				245	"networkId": "A String", # Network to use to publish the export.
				246	"noRootSquash": True or False, # Disable root squashing.
				247	"permissions": "A String", # Export permissions.
				248	},
				249	],
				250	"protocol": "A String", # Volume protocol.
				251	"sizeGb": 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field.
				252	"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
				253	"type": "A String", # The type of this Volume.
				254	},
				255	],
				256	}</pre>
				257	</div>
				258
				259	</body></html>