Google Git
Sign in
flutter / third_party / googleapis.dart.git / refs/heads/master / . / generated / googleapis / lib / baremetalsolution / v2.dart
blob: ab17adc9e36f52a6320388f0eaa4c553646fe57d [file] [log] [blame] [edit]
// This is a generated file (see the discoveryapis_generator project).
// ignore_for_file: camel_case_types
// ignore_for_file: comment_references
// ignore_for_file: deprecated_member_use_from_same_package
// ignore_for_file: doc_directive_unknown
// ignore_for_file: lines_longer_than_80_chars
// ignore_for_file: non_constant_identifier_names
// ignore_for_file: prefer_interpolation_to_compose_strings
// ignore_for_file: unintended_html_in_doc_comment
// ignore_for_file: unnecessary_brace_in_string_interps
// ignore_for_file: unnecessary_lambdas
// ignore_for_file: unnecessary_string_interpolations
/// Bare Metal Solution API - v2
///
/// Provides ways to manage Bare Metal Solution hardware installed in a regional
/// extension located near a Google Cloud data center.
///
/// For more information, see <https://cloud.google.com/bare-metal>
///
/// Create an instance of [BaremetalsolutionApi] to access these resources:
///
/// - [ProjectsResource]
/// - [ProjectsLocationsResource]
/// - [ProjectsLocationsInstancesResource]
/// - [ProjectsLocationsNetworksResource]
/// - [ProjectsLocationsNfsSharesResource]
/// - [ProjectsLocationsOperationsResource]
/// - [ProjectsLocationsOsImagesResource]
/// - [ProjectsLocationsProvisioningConfigsResource]
/// - [ProjectsLocationsProvisioningQuotasResource]
/// - [ProjectsLocationsSshKeysResource]
/// - [ProjectsLocationsVolumesResource]
/// - [ProjectsLocationsVolumesLunsResource]
/// - [ProjectsLocationsVolumesSnapshotsResource]
library;
import 'dart:async' as async;
import 'dart:convert' as convert;
import 'dart:core' as core;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
import '../shared.dart';
import '../src/user_agent.dart';
export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
show ApiRequestError, DetailedApiRequestError;
/// Provides ways to manage Bare Metal Solution hardware installed in a regional
/// extension located near a Google Cloud data center.
class BaremetalsolutionApi {
/// See, edit, configure, and delete your Google Cloud data and see the email
/// address for your Google Account.
static const cloudPlatformScope =
'https://www.googleapis.com/auth/cloud-platform';
final commons.ApiRequester _requester;
ProjectsResource get projects => ProjectsResource(_requester);
BaremetalsolutionApi(
http.Client client, {
core.String rootUrl = 'https://baremetalsolution.googleapis.com/',
core.String servicePath = '',
}) : _requester = commons.ApiRequester(
client,
rootUrl,
servicePath,
requestHeaders,
);
}
class ProjectsResource {
final commons.ApiRequester _requester;
ProjectsLocationsResource get locations =>
ProjectsLocationsResource(_requester);
ProjectsResource(commons.ApiRequester client) : _requester = client;
}
class ProjectsLocationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsInstancesResource get instances =>
ProjectsLocationsInstancesResource(_requester);
ProjectsLocationsNetworksResource get networks =>
ProjectsLocationsNetworksResource(_requester);
ProjectsLocationsNfsSharesResource get nfsShares =>
ProjectsLocationsNfsSharesResource(_requester);
ProjectsLocationsOperationsResource get operations =>
ProjectsLocationsOperationsResource(_requester);
ProjectsLocationsOsImagesResource get osImages =>
ProjectsLocationsOsImagesResource(_requester);
ProjectsLocationsProvisioningConfigsResource get provisioningConfigs =>
ProjectsLocationsProvisioningConfigsResource(_requester);
ProjectsLocationsProvisioningQuotasResource get provisioningQuotas =>
ProjectsLocationsProvisioningQuotasResource(_requester);
ProjectsLocationsSshKeysResource get sshKeys =>
ProjectsLocationsSshKeysResource(_requester);
ProjectsLocationsVolumesResource get volumes =>
ProjectsLocationsVolumesResource(_requester);
ProjectsLocationsResource(commons.ApiRequester client) : _requester = client;
/// Gets information about a location.
///
/// Request parameters:
///
/// [name] - Resource name for the location.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Location].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Location> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Location.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Lists information about the supported locations for this service.
///
/// Request parameters:
///
/// [name] - The resource that owns the locations collection, if applicable.
/// Value must have pattern `^projects/\[^/\]+$`.
///
/// [extraLocationTypes] - Optional. A list of extra location types that
/// should be used as conditions for controlling the visibility of the
/// locations.
///
/// [filter] - A filter to narrow down results to a preferred subset. The
/// filtering language accepts strings like `"displayName=tokyo"`, and is
/// documented in more detail in \[AIP-160\](https://google.aip.dev/160).
///
/// [pageSize] - The maximum number of results to return. If not set, the
/// service selects a default.
///
/// [pageToken] - A page token received from the `next_page_token` field in
/// the response. Send that page token to receive the subsequent page.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListLocationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListLocationsResponse> list(
core.String name, {
core.List<core.String>? extraLocationTypes,
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (extraLocationTypes != null) 'extraLocationTypes': extraLocationTypes,
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + '/locations';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListLocationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsInstancesResource {
final commons.ApiRequester _requester;
ProjectsLocationsInstancesResource(commons.ApiRequester client)
: _requester = client;
/// Detach LUN from Instance.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [instance] - Required. Name of the instance.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> detachLun(
DetachLunRequest request,
core.String instance, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$instance') + ':detachLun';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Perform disable hyperthreading operation on a single server.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The `name` field is used to identify the instance.
/// Format: projects/{project}/locations/{location}/instances/{instance}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> disableHyperthreading(
DisableHyperthreadingRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v2/' + core.Uri.encodeFull('$name') + ':disableHyperthreading';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Disable the interactive serial console feature on an instance.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> disableInteractiveSerialConsole(
DisableInteractiveSerialConsoleRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v2/' +
core.Uri.encodeFull('$name') +
':disableInteractiveSerialConsole';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Perform enable hyperthreading operation on a single server.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The `name` field is used to identify the instance.
/// Format: projects/{project}/locations/{location}/instances/{instance}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> enableHyperthreading(
EnableHyperthreadingRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':enableHyperthreading';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Enable the interactive serial console feature on an instance.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> enableInteractiveSerialConsole(
EnableInteractiveSerialConsoleRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v2/' +
core.Uri.encodeFull('$name') +
':enableInteractiveSerialConsole';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Get details about a single server.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Instance].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Instance> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Instance.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// List servers in a given project and location.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListInstancesRequest.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [filter] - List filter.
///
/// [pageSize] - Requested page size. Server may return fewer items than
/// requested. If unspecified, the server will pick an appropriate default.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListInstancesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListInstancesResponse> list(
core.String parent, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/instances';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListInstancesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Load auth info for a server.
///
/// Request parameters:
///
/// [name] - Required. Name of the server.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [LoadInstanceAuthInfoResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<LoadInstanceAuthInfoResponse> loadAuthInfo(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':loadAuthInfo';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return LoadInstanceAuthInfoResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Update details of a single server.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Immutable. The resource name of this `Instance`. Resource names
/// are schemeless URIs that follow the conventions in
/// https://cloud.google.com/apis/design/resource_names. Format:
/// `projects/{project}/locations/{location}/instances/{instance}`
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [updateMask] - The list of fields to update. The currently supported
/// fields are: `labels` `hyperthreading_enabled` `os_image` `ssh_keys`
/// `kms_key_version`
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> patch(
Instance request,
core.String name, {
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Perform reimage operation on a single server.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The `name` field is used to identify the instance.
/// Format: projects/{project}/locations/{location}/instances/{instance}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> reimage(
ReimageInstanceRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':reimage';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// RenameInstance sets a new name for an instance.
///
/// Use with caution, previous names become immediately invalidated.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The `name` field is used to identify the instance.
/// Format: projects/{project}/locations/{location}/instances/{instance}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Instance].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Instance> rename(
RenameInstanceRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':rename';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Instance.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Perform an ungraceful, hard reset on a server.
///
/// Equivalent to shutting the power off and then turning it back on.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> reset(
ResetInstanceRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':reset';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Starts a server that was shutdown.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> start(
StartInstanceRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':start';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Stop a running server.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> stop(
StopInstanceRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':stop';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
}
class ProjectsLocationsNetworksResource {
final commons.ApiRequester _requester;
ProjectsLocationsNetworksResource(commons.ApiRequester client)
: _requester = client;
/// Get details of a single network.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/networks/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Network].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Network> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Network.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// List network in a given project and location.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListNetworksRequest.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [filter] - List filter.
///
/// [pageSize] - Requested page size. The server might return fewer items than
/// requested. If unspecified, server will pick an appropriate default.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListNetworksResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListNetworksResponse> list(
core.String parent, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/networks';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListNetworksResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// List all Networks (and used IPs for each Network) in the vendor account
/// associated with the specified project.
///
/// Request parameters:
///
/// [location] - Required. Parent value (project and location).
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListNetworkUsageResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListNetworkUsageResponse> listNetworkUsage(
core.String location, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v2/' + core.Uri.encodeFull('$location') + '/networks:listNetworkUsage';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListNetworkUsageResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Update details of a single network.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Output only. The resource name of this `Network`. Resource names
/// are schemeless URIs that follow the conventions in
/// https://cloud.google.com/apis/design/resource_names. Format:
/// `projects/{project}/locations/{location}/networks/{network}`
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/networks/\[^/\]+$`.
///
/// [updateMask] - The list of fields to update. The only currently supported
/// fields are: `labels`, `reservations`, `vrf.vlan_attachments`
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> patch(
Network request,
core.String name, {
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// RenameNetwork sets a new name for a network.
///
/// Use with caution, previous names become immediately invalidated.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The `name` field is used to identify the network.
/// Format: projects/{project}/locations/{location}/networks/{network}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/networks/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Network].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Network> rename(
RenameNetworkRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':rename';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Network.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
}
class ProjectsLocationsNfsSharesResource {
final commons.ApiRequester _requester;
ProjectsLocationsNfsSharesResource(commons.ApiRequester client)
: _requester = client;
/// Create an NFS share.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The parent project and location.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> create(
NfsShare request,
core.String parent, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/nfsShares';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Delete an NFS share.
///
/// The underlying volume is automatically deleted.
///
/// Request parameters:
///
/// [name] - Required. The name of the NFS share to delete.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/nfsShares/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> delete(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Get details of a single NFS share.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/nfsShares/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [NfsShare].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<NfsShare> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return NfsShare.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// List NFS shares.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListNfsSharesRequest.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [filter] - List filter.
///
/// [pageSize] - Requested page size. The server might return fewer items than
/// requested. If unspecified, server will pick an appropriate default.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListNfsSharesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListNfsSharesResponse> list(
core.String parent, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/nfsShares';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListNfsSharesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Update details of a single NFS share.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Immutable. The name of the NFS share.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/nfsShares/\[^/\]+$`.
///
/// [updateMask] - The list of fields to update. The only currently supported
/// fields are: `labels` `allowed_clients`
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> patch(
NfsShare request,
core.String name, {
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// RenameNfsShare sets a new name for an nfsshare.
///
/// Use with caution, previous names become immediately invalidated.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The `name` field is used to identify the nfsshare.
/// Format: projects/{project}/locations/{location}/nfsshares/{nfsshare}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/nfsShares/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [NfsShare].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<NfsShare> rename(
RenameNfsShareRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':rename';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return NfsShare.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
}
class ProjectsLocationsOperationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsOperationsResource(commons.ApiRequester client)
: _requester = client;
/// Get details about an operation.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
}
class ProjectsLocationsOsImagesResource {
final commons.ApiRequester _requester;
ProjectsLocationsOsImagesResource(commons.ApiRequester client)
: _requester = client;
/// Get details of a single OS image.
///
/// Request parameters:
///
/// [name] - Required. Name of the OS image.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/osImages/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [OSImage].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<OSImage> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return OSImage.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Retrieves the list of OS images which are currently approved.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListOSImagesRequest.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [pageSize] - Requested page size. The server might return fewer items than
/// requested. If unspecified, server will pick an appropriate default. Notice
/// that page_size field is not supported and won't be respected in the API
/// request for now, will be updated when pagination is supported.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListOSImagesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListOSImagesResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/osImages';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListOSImagesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsProvisioningConfigsResource {
final commons.ApiRequester _requester;
ProjectsLocationsProvisioningConfigsResource(commons.ApiRequester client)
: _requester = client;
/// Create new ProvisioningConfig.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The parent project and location containing the
/// ProvisioningConfig.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [email] - Optional. Email provided to send a confirmation with
/// provisioning config to.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ProvisioningConfig].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ProvisioningConfig> create(
ProvisioningConfig request,
core.String parent, {
core.String? email,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (email != null) 'email': [email],
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v2/' + core.Uri.encodeFull('$parent') + '/provisioningConfigs';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return ProvisioningConfig.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Get ProvisioningConfig by name.
///
/// Request parameters:
///
/// [name] - Required. Name of the ProvisioningConfig.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/provisioningConfigs/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ProvisioningConfig].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ProvisioningConfig> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ProvisioningConfig.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Update existing ProvisioningConfig.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Output only. The system-generated name of the provisioning
/// config. This follows the UUID format.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/provisioningConfigs/\[^/\]+$`.
///
/// [email] - Optional. Email provided to send a confirmation with
/// provisioning config to.
///
/// [updateMask] - Required. The list of fields to update.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ProvisioningConfig].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ProvisioningConfig> patch(
ProvisioningConfig request,
core.String name, {
core.String? email,
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (email != null) 'email': [email],
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return ProvisioningConfig.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Submit a provisioning configuration for a given project.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The parent project and location containing the
/// ProvisioningConfig.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [SubmitProvisioningConfigResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<SubmitProvisioningConfigResponse> submit(
SubmitProvisioningConfigRequest request,
core.String parent, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v2/' + core.Uri.encodeFull('$parent') + '/provisioningConfigs:submit';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return SubmitProvisioningConfigResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsProvisioningQuotasResource {
final commons.ApiRequester _requester;
ProjectsLocationsProvisioningQuotasResource(commons.ApiRequester client)
: _requester = client;
/// List the budget details to provision resources on a given project.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListProvisioningQuotasRequest.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [pageSize] - Requested page size. The server might return fewer items than
/// requested. If unspecified, server will pick an appropriate default. Notice
/// that page_size field is not supported and won't be respected in the API
/// request for now, will be updated when pagination is supported.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListProvisioningQuotasResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListProvisioningQuotasResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/provisioningQuotas';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListProvisioningQuotasResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsSshKeysResource {
final commons.ApiRequester _requester;
ProjectsLocationsSshKeysResource(commons.ApiRequester client)
: _requester = client;
/// Register a public SSH key in the specified project for use with the
/// interactive serial console feature.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The parent containing the SSH keys.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [sshKeyId] - Required. The ID to use for the key, which will become the
/// final component of the key's resource name. This value must match the
/// regex: \[a-zA-Z0-9@.\-_\]{1,64}
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [SSHKey].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<SSHKey> create(
SSHKey request,
core.String parent, {
core.String? sshKeyId,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (sshKeyId != null) 'sshKeyId': [sshKeyId],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/sshKeys';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return SSHKey.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Deletes a public SSH key registered in the specified project.
///
/// Request parameters:
///
/// [name] - Required. The name of the SSH key to delete. Currently, the only
/// valid value for the location is "global".
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/sshKeys/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Lists the public SSH keys registered for the specified project.
///
/// These SSH keys are used only for the interactive serial console feature.
///
/// Request parameters:
///
/// [parent] - Required. The parent containing the SSH keys. Currently, the
/// only valid value for the location is "global".
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [pageSize] - The maximum number of items to return.
///
/// [pageToken] - The next_page_token value returned from a previous List
/// request, if any.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListSSHKeysResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListSSHKeysResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/sshKeys';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListSSHKeysResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsVolumesResource {
final commons.ApiRequester _requester;
ProjectsLocationsVolumesLunsResource get luns =>
ProjectsLocationsVolumesLunsResource(_requester);
ProjectsLocationsVolumesSnapshotsResource get snapshots =>
ProjectsLocationsVolumesSnapshotsResource(_requester);
ProjectsLocationsVolumesResource(commons.ApiRequester client)
: _requester = client;
/// Skips volume's cooloff and deletes it now.
///
/// Volume must be in cooloff state.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The name of the Volume.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> evict(
EvictVolumeRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':evict';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Get details of a single storage volume.
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Volume].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Volume> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Volume.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// List storage volumes in a given project and location.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListVolumesRequest.
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [filter] - List filter.
///
/// [pageSize] - Requested page size. The server might return fewer items than
/// requested. If unspecified, server will pick an appropriate default.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListVolumesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListVolumesResponse> list(
core.String parent, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/volumes';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListVolumesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Update details of a single storage volume.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Output only. The resource name of this `Volume`. Resource names
/// are schemeless URIs that follow the conventions in
/// https://cloud.google.com/apis/design/resource_names. Format:
/// `projects/{project}/locations/{location}/volumes/{volume}`
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [updateMask] - The list of fields to update. The only currently supported
/// fields are: 'labels'
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> patch(
Volume request,
core.String name, {
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// RenameVolume sets a new name for a volume.
///
/// Use with caution, previous names become immediately invalidated.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The `name` field is used to identify the volume.
/// Format: projects/{project}/locations/{location}/volumes/{volume}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Volume].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Volume> rename(
RenameVolumeRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':rename';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Volume.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Emergency Volume resize.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [volume] - Required. Volume to resize.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> resize(
ResizeVolumeRequest request,
core.String volume, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$volume') + ':resize';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
}
class ProjectsLocationsVolumesLunsResource {
final commons.ApiRequester _requester;
ProjectsLocationsVolumesLunsResource(commons.ApiRequester client)
: _requester = client;
/// Skips lun's cooloff and deletes it now.
///
/// Lun must be in cooloff state.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The name of the lun.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+/luns/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> evict(
EvictLunRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':evict';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Get details of a single storage logical unit number(LUN).
///
/// Request parameters:
///
/// [name] - Required. Name of the resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+/luns/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Lun].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Lun> get(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Lun.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// List storage volume luns for given storage volume.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListLunsRequest.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [pageSize] - Requested page size. The server might return fewer items than
/// requested. If unspecified, server will pick an appropriate default.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListLunsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListLunsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/luns';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListLunsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsVolumesSnapshotsResource {
final commons.ApiRequester _requester;
ProjectsLocationsVolumesSnapshotsResource(commons.ApiRequester client)
: _requester = client;
/// Takes a snapshot of a boot volume.
///
/// Returns INVALID_ARGUMENT if called for a non-boot volume.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The volume to snapshot.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [VolumeSnapshot].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<VolumeSnapshot> create(
VolumeSnapshot request,
core.String parent, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/snapshots';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return VolumeSnapshot.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Deletes a volume snapshot.
///
/// Returns INVALID_ARGUMENT if called for a non-boot volume.
///
/// Request parameters:
///
/// [name] - Required. The name of the snapshot to delete.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+/snapshots/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(core.String name, {core.String? $fields}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
/// Returns the specified snapshot resource.
///
/// Returns INVALID_ARGUMENT if called for a non-boot volume.
///
/// Request parameters:
///
/// [name] - Required. The name of the snapshot.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+/snapshots/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [VolumeSnapshot].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<VolumeSnapshot> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return VolumeSnapshot.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Retrieves the list of snapshots for the specified volume.
///
/// Returns a response with an empty list of snapshots if called for a
/// non-boot volume.
///
/// Request parameters:
///
/// [parent] - Required. Parent value for ListVolumesRequest.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+$`.
///
/// [pageSize] - Requested page size. The server might return fewer items than
/// requested. If unspecified, server will pick an appropriate default.
///
/// [pageToken] - A token identifying a page of results from the server.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListVolumeSnapshotsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListVolumeSnapshotsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/snapshots';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListVolumeSnapshotsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Uses the specified snapshot to restore its parent volume.
///
/// Returns INVALID_ARGUMENT if called for a non-boot volume.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [volumeSnapshot] - Required. Name of the snapshot which will be used to
/// restore its parent volume.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/volumes/\[^/\]+/snapshots/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> restoreVolumeSnapshot(
RestoreVolumeSnapshotRequest request,
core.String volumeSnapshot, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v2/' +
core.Uri.encodeFull('$volumeSnapshot') +
':restoreVolumeSnapshot';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}
}
/// Represents an 'access point' for the share.
class AllowedClient {
/// Allow dev flag.
///
/// Which controls whether to allow creation of devices.
core.bool? allowDev;
/// Allow the setuid flag.
core.bool? allowSuid;
/// The subnet of IP addresses permitted to access the share.
core.String? allowedClientsCidr;
/// Mount permissions.
/// Possible string values are:
/// - "MOUNT_PERMISSIONS_UNSPECIFIED" : Permissions were not specified.
/// - "READ" : NFS share can be mount with read-only permissions.
/// - "READ_WRITE" : NFS share can be mount with read-write permissions.
core.String? mountPermissions;
/// The network the access point sits on.
core.String? network;
/// The path to access NFS, in format shareIP:/InstanceID InstanceID is the
/// generated ID instead of customer provided name.
///
/// example like "10.0.0.0:/g123456789-nfs001"
///
/// Output only.
core.String? nfsPath;
/// Disable root squashing, which is a feature of NFS.
///
/// Root squash is a special mapping of the remote superuser (root) identity
/// when using identity authentication.
core.bool? noRootSquash;
/// The IP address of the share on this network.
///
/// Assigned automatically during provisioning based on the network's
/// services_cidr.
///
/// Output only.
core.String? shareIp;
AllowedClient({
this.allowDev,
this.allowSuid,
this.allowedClientsCidr,
this.mountPermissions,
this.network,
this.nfsPath,
this.noRootSquash,
this.shareIp,
});
AllowedClient.fromJson(core.Map json_)
: this(
allowDev: json_['allowDev'] as core.bool?,
allowSuid: json_['allowSuid'] as core.bool?,
allowedClientsCidr: json_['allowedClientsCidr'] as core.String?,
mountPermissions: json_['mountPermissions'] as core.String?,
network: json_['network'] as core.String?,
nfsPath: json_['nfsPath'] as core.String?,
noRootSquash: json_['noRootSquash'] as core.bool?,
shareIp: json_['shareIp'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (allowDev != null) 'allowDev': allowDev!,
if (allowSuid != null) 'allowSuid': allowSuid!,
if (allowedClientsCidr != null) 'allowedClientsCidr': allowedClientsCidr!,
if (mountPermissions != null) 'mountPermissions': mountPermissions!,
if (network != null) 'network': network!,
if (nfsPath != null) 'nfsPath': nfsPath!,
if (noRootSquash != null) 'noRootSquash': noRootSquash!,
if (shareIp != null) 'shareIp': shareIp!,
};
}
/// Message for detach specific LUN from an Instance.
class DetachLunRequest {
/// Name of the Lun to detach.
///
/// Required.
core.String? lun;
/// If true, performs lun unmapping without instance reboot.
core.bool? skipReboot;
DetachLunRequest({this.lun, this.skipReboot});
DetachLunRequest.fromJson(core.Map json_)
: this(
lun: json_['lun'] as core.String?,
skipReboot: json_['skipReboot'] as core.bool?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (lun != null) 'lun': lun!,
if (skipReboot != null) 'skipReboot': skipReboot!,
};
}
/// Message requesting to perform disable hyperthreading operation on a server.
typedef DisableHyperthreadingRequest = $Empty;
/// Message for disabling the interactive serial console on an instance.
typedef DisableInteractiveSerialConsoleRequest = $Empty;
/// A generic empty message that you can re-use to avoid defining duplicated
/// empty messages in your APIs.
///
/// A typical example is to use it as the request or the response type of an API
/// method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns
/// (google.protobuf.Empty); }
typedef Empty = $Empty;
/// Message requesting to perform enable hyperthreading operation on a server.
typedef EnableHyperthreadingRequest = $Empty;
/// Message for enabling the interactive serial console on an instance.
typedef EnableInteractiveSerialConsoleRequest = $Empty;
/// Request for skip lun cooloff and delete it.
typedef EvictLunRequest = $Empty;
/// Request for skip volume cooloff and delete it.
typedef EvictVolumeRequest = $Empty;
/// Each logical interface represents a logical abstraction of the underlying
/// physical interface (for eg.
///
/// bond, nic) of the instance. Each logical interface can effectively map to
/// multiple network-IP pairs and still be mapped to one underlying physical
/// interface.
class GoogleCloudBaremetalsolutionV2LogicalInterface {
/// The index of the logical interface mapping to the index of the hardware
/// bond or nic on the chosen network template.
///
/// This field is deprecated.
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
core.int? interfaceIndex;
/// List of logical network interfaces within a logical interface.
core.List<LogicalNetworkInterface>? logicalNetworkInterfaces;
/// Interface name.
///
/// This is of syntax or and forms part of the network template name.
core.String? name;
GoogleCloudBaremetalsolutionV2LogicalInterface({
this.interfaceIndex,
this.logicalNetworkInterfaces,
this.name,
});
GoogleCloudBaremetalsolutionV2LogicalInterface.fromJson(core.Map json_)
: this(
interfaceIndex: json_['interfaceIndex'] as core.int?,
logicalNetworkInterfaces:
(json_['logicalNetworkInterfaces'] as core.List?)
?.map(
(value) => LogicalNetworkInterface.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
name: json_['name'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (interfaceIndex != null) 'interfaceIndex': interfaceIndex!,
if (logicalNetworkInterfaces != null)
'logicalNetworkInterfaces': logicalNetworkInterfaces!,
if (name != null) 'name': name!,
};
}
/// A server.
class Instance {
/// Create a time stamp.
///
/// Output only.
core.String? createTime;
/// The firmware version for the instance.
///
/// Output only.
core.String? firmwareVersion;
/// True if you enable hyperthreading for the server, otherwise false.
///
/// The default value is false.
core.bool? hyperthreadingEnabled;
/// An identifier for the `Instance`, generated by the backend.
///
/// Output only.
core.String? id;
/// True if the interactive serial console feature is enabled for the
/// instance, false otherwise.
///
/// The default value is false.
///
/// Output only.
core.bool? interactiveSerialConsoleEnabled;
/// Name of the KMS crypto key version used to encrypt the initial passwords.
///
/// The key has to have ASYMMETRIC_DECRYPT purpose. Format is
/// `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
///
/// Optional.
core.String? kmsKeyVersion;
/// Labels as key value pairs.
core.Map<core.String, core.String>? labels;
/// List of logical interfaces for the instance.
///
/// The number of logical interfaces will be the same as number of hardware
/// bond/nic on the chosen network template. For the non-multivlan
/// configurations (for eg, existing servers) that use existing default
/// network template (bondaa-bondaa), both the Instance.networks field and the
/// Instance.logical_interfaces fields will be filled to ensure backward
/// compatibility. For the others, only Instance.logical_interfaces will be
/// filled.
core.List<GoogleCloudBaremetalsolutionV2LogicalInterface>? logicalInterfaces;
/// Text field about info for logging in.
///
/// Output only.
core.String? loginInfo;
/// List of LUNs associated with this server.
///
/// Immutable.
core.List<Lun>? luns;
/// The server type.
///
/// [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
///
/// Immutable.
core.String? machineType;
/// The resource name of this `Instance`.
///
/// Resource names are schemeless URIs that follow the conventions in
/// https://cloud.google.com/apis/design/resource_names. Format:
/// `projects/{project}/locations/{location}/instances/{instance}`
///
/// Immutable.
core.String? name;
/// Instance network template name.
///
/// For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name
/// follows the syntax of "bond" or "nic".
core.String? networkTemplate;
/// List of networks associated with this server.
///
/// Output only.
core.List<Network>? networks;
/// The OS image currently installed on the server.
core.String? osImage;
/// Pod name.
///
/// Pod is an independent part of infrastructure. Instance can only be
/// connected to the assets (networks, volumes) allocated in the same pod.
///
/// Immutable.
core.String? pod;
/// List of SSH Keys used during instance provisioning.
///
/// Optional.
core.List<core.String>? sshKeys;
/// The state of the server.
///
/// Output only.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The server is in an unknown state.
/// - "PROVISIONING" : The server is being provisioned.
/// - "RUNNING" : The server is running.
/// - "DELETED" : The server has been deleted.
/// - "UPDATING" : The server is being updated.
/// - "STARTING" : The server is starting.
/// - "STOPPING" : The server is stopping.
/// - "SHUTDOWN" : The server is shutdown.
core.String? state;
/// Update a time stamp.
///
/// Output only.
core.String? updateTime;
/// Input only.
///
/// List of Volumes to attach to this Instance on creation. This field won't
/// be populated in Get/List responses.
core.List<Volume>? volumes;
/// The workload profile for the instance.
/// Possible string values are:
/// - "WORKLOAD_PROFILE_UNSPECIFIED" : The workload profile is in an unknown
/// state.
/// - "WORKLOAD_PROFILE_GENERIC" : The workload profile is generic.
/// - "WORKLOAD_PROFILE_HANA" : The workload profile is hana.
core.String? workloadProfile;
Instance({
this.createTime,
this.firmwareVersion,
this.hyperthreadingEnabled,
this.id,
this.interactiveSerialConsoleEnabled,
this.kmsKeyVersion,
this.labels,
this.logicalInterfaces,
this.loginInfo,
this.luns,
this.machineType,
this.name,
this.networkTemplate,
this.networks,
this.osImage,
this.pod,
this.sshKeys,
this.state,
this.updateTime,
this.volumes,
this.workloadProfile,
});
Instance.fromJson(core.Map json_)
: this(
createTime: json_['createTime'] as core.String?,
firmwareVersion: json_['firmwareVersion'] as core.String?,
hyperthreadingEnabled: json_['hyperthreadingEnabled'] as core.bool?,
id: json_['id'] as core.String?,
interactiveSerialConsoleEnabled:
json_['interactiveSerialConsoleEnabled'] as core.bool?,
kmsKeyVersion: json_['kmsKeyVersion'] as core.String?,
labels: (json_['labels'] as core.Map<core.String, core.dynamic>?)?.map(
(key, value) => core.MapEntry(key, value as core.String),
),
logicalInterfaces:
(json_['logicalInterfaces'] as core.List?)
?.map(
(value) =>
GoogleCloudBaremetalsolutionV2LogicalInterface.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
loginInfo: json_['loginInfo'] as core.String?,
luns:
(json_['luns'] as core.List?)
?.map(
(value) => Lun.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
machineType: json_['machineType'] as core.String?,
name: json_['name'] as core.String?,
networkTemplate: json_['networkTemplate'] as core.String?,
networks:
(json_['networks'] as core.List?)
?.map(
(value) => Network.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
osImage: json_['osImage'] as core.String?,
pod: json_['pod'] as core.String?,
sshKeys:
(json_['sshKeys'] as core.List?)
?.map((value) => value as core.String)
.toList(),
state: json_['state'] as core.String?,
updateTime: json_['updateTime'] as core.String?,
volumes:
(json_['volumes'] as core.List?)
?.map(
(value) => Volume.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
workloadProfile: json_['workloadProfile'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (createTime != null) 'createTime': createTime!,
if (firmwareVersion != null) 'firmwareVersion': firmwareVersion!,
if (hyperthreadingEnabled != null)
'hyperthreadingEnabled': hyperthreadingEnabled!,
if (id != null) 'id': id!,
if (interactiveSerialConsoleEnabled != null)
'interactiveSerialConsoleEnabled': interactiveSerialConsoleEnabled!,
if (kmsKeyVersion != null) 'kmsKeyVersion': kmsKeyVersion!,
if (labels != null) 'labels': labels!,
if (logicalInterfaces != null) 'logicalInterfaces': logicalInterfaces!,
if (loginInfo != null) 'loginInfo': loginInfo!,
if (luns != null) 'luns': luns!,
if (machineType != null) 'machineType': machineType!,
if (name != null) 'name': name!,
if (networkTemplate != null) 'networkTemplate': networkTemplate!,
if (networks != null) 'networks': networks!,
if (osImage != null) 'osImage': osImage!,
if (pod != null) 'pod': pod!,
if (sshKeys != null) 'sshKeys': sshKeys!,
if (state != null) 'state': state!,
if (updateTime != null) 'updateTime': updateTime!,
if (volumes != null) 'volumes': volumes!,
if (workloadProfile != null) 'workloadProfile': workloadProfile!,
};
}
/// Configuration parameters for a new instance.
class InstanceConfig {
/// If true networks can be from different projects of the same vendor
/// account.
core.bool? accountNetworksEnabled;
/// Client network address.
///
/// Filled if InstanceConfig.multivlan_config is false.
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
NetworkAddress? clientNetwork;
/// Whether the instance should be provisioned with Hyperthreading enabled.
core.bool? hyperthreading;
/// A transient unique identifier to identify an instance within an
/// ProvisioningConfig request.
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
core.String? id;
/// Instance type.
///
/// [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
core.String? instanceType;
/// Name of the KMS crypto key version used to encrypt the initial passwords.
///
/// The key has to have ASYMMETRIC_DECRYPT purpose.
core.String? kmsKeyVersion;
/// List of logical interfaces for the instance.
///
/// The number of logical interfaces will be the same as number of hardware
/// bond/nic on the chosen network template. Filled if
/// InstanceConfig.multivlan_config is true.
core.List<GoogleCloudBaremetalsolutionV2LogicalInterface>? logicalInterfaces;
/// The name of the instance config.
core.String? name;
/// The type of network configuration on the instance.
/// Possible string values are:
/// - "NETWORKCONFIG_UNSPECIFIED" : The unspecified network configuration.
/// - "SINGLE_VLAN" : Instance part of single client network and single
/// private network.
/// - "MULTI_VLAN" : Instance part of multiple (or single) client networks and
/// private networks.
core.String? networkConfig;
/// Server network template name.
///
/// Filled if InstanceConfig.multivlan_config is true.
core.String? networkTemplate;
/// OS image to initialize the instance.
///
/// [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
core.String? osImage;
/// Private network address, if any.
///
/// Filled if InstanceConfig.multivlan_config is false.
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
NetworkAddress? privateNetwork;
/// List of names of ssh keys used to provision the instance.
///
/// Optional.
core.List<core.String>? sshKeyNames;
/// User note field, it can be used by customers to add additional information
/// for the BMS Ops team .
core.String? userNote;
InstanceConfig({
this.accountNetworksEnabled,
this.clientNetwork,
this.hyperthreading,
this.id,
this.instanceType,
this.kmsKeyVersion,
this.logicalInterfaces,
this.name,
this.networkConfig,
this.networkTemplate,
this.osImage,
this.privateNetwork,
this.sshKeyNames,
this.userNote,
});
InstanceConfig.fromJson(core.Map json_)
: this(
accountNetworksEnabled: json_['accountNetworksEnabled'] as core.bool?,
clientNetwork:
json_.containsKey('clientNetwork')
? NetworkAddress.fromJson(
json_['clientNetwork'] as core.Map<core.String, core.dynamic>,
)
: null,
hyperthreading: json_['hyperthreading'] as core.bool?,
id: json_['id'] as core.String?,
instanceType: json_['instanceType'] as core.String?,
kmsKeyVersion: json_['kmsKeyVersion'] as core.String?,
logicalInterfaces:
(json_['logicalInterfaces'] as core.List?)
?.map(
(value) =>
GoogleCloudBaremetalsolutionV2LogicalInterface.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
name: json_['name'] as core.String?,
networkConfig: json_['networkConfig'] as core.String?,
networkTemplate: json_['networkTemplate'] as core.String?,
osImage: json_['osImage'] as core.String?,
privateNetwork:
json_.containsKey('privateNetwork')
? NetworkAddress.fromJson(
json_['privateNetwork']
as core.Map<core.String, core.dynamic>,
)
: null,
sshKeyNames:
(json_['sshKeyNames'] as core.List?)
?.map((value) => value as core.String)
.toList(),
userNote: json_['userNote'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (accountNetworksEnabled != null)
'accountNetworksEnabled': accountNetworksEnabled!,
if (clientNetwork != null) 'clientNetwork': clientNetwork!,
if (hyperthreading != null) 'hyperthreading': hyperthreading!,
if (id != null) 'id': id!,
if (instanceType != null) 'instanceType': instanceType!,
if (kmsKeyVersion != null) 'kmsKeyVersion': kmsKeyVersion!,
if (logicalInterfaces != null) 'logicalInterfaces': logicalInterfaces!,
if (name != null) 'name': name!,
if (networkConfig != null) 'networkConfig': networkConfig!,
if (networkTemplate != null) 'networkTemplate': networkTemplate!,
if (osImage != null) 'osImage': osImage!,
if (privateNetwork != null) 'privateNetwork': privateNetwork!,
if (sshKeyNames != null) 'sshKeyNames': sshKeyNames!,
if (userNote != null) 'userNote': userNote!,
};
}
/// A resource budget.
class InstanceQuota {
/// Number of machines than can be created for the given location and
/// instance_type.
core.int? availableMachineCount;
/// The gcp service of the provisioning quota.
core.String? gcpService;
/// Instance type.
///
/// Deprecated: use gcp_service.
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
core.String? instanceType;
/// Location where the quota applies.
core.String? location;
/// The name of the instance quota.
///
/// Output only.
core.String? name;
InstanceQuota({
this.availableMachineCount,
this.gcpService,
this.instanceType,
this.location,
this.name,
});
InstanceQuota.fromJson(core.Map json_)
: this(
availableMachineCount: json_['availableMachineCount'] as core.int?,
gcpService: json_['gcpService'] as core.String?,
instanceType: json_['instanceType'] as core.String?,
location: json_['location'] as core.String?,
name: json_['name'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (availableMachineCount != null)
'availableMachineCount': availableMachineCount!,
if (gcpService != null) 'gcpService': gcpService!,
if (instanceType != null) 'instanceType': instanceType!,
if (location != null) 'location': location!,
if (name != null) 'name': name!,
};
}
/// A GCP vlan attachment.
class IntakeVlanAttachment {
/// Identifier of the VLAN attachment.
core.String? id;
/// Attachment pairing key.
core.String? pairingKey;
IntakeVlanAttachment({this.id, this.pairingKey});
IntakeVlanAttachment.fromJson(core.Map json_)
: this(
id: json_['id'] as core.String?,
pairingKey: json_['pairingKey'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (id != null) 'id': id!,
if (pairingKey != null) 'pairingKey': pairingKey!,
};
}
/// Response message for the list of servers.
class ListInstancesResponse {
/// The list of servers.
core.List<Instance>? instances;
/// A token identifying a page of results from the server.
core.String? nextPageToken;
/// Locations that could not be reached.
core.List<core.String>? unreachable;
ListInstancesResponse({this.instances, this.nextPageToken, this.unreachable});
ListInstancesResponse.fromJson(core.Map json_)
: this(
instances:
(json_['instances'] as core.List?)
?.map(
(value) => Instance.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
nextPageToken: json_['nextPageToken'] as core.String?,
unreachable:
(json_['unreachable'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (instances != null) 'instances': instances!,
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (unreachable != null) 'unreachable': unreachable!,
};
}
/// The response message for Locations.ListLocations.
class ListLocationsResponse {
/// A list of locations that matches the specified filter in the request.
core.List<Location>? locations;
/// The standard List next-page token.
core.String? nextPageToken;
ListLocationsResponse({this.locations, this.nextPageToken});
ListLocationsResponse.fromJson(core.Map json_)
: this(
locations:
(json_['locations'] as core.List?)
?.map(
(value) => Location.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
nextPageToken: json_['nextPageToken'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (locations != null) 'locations': locations!,
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
};
}
/// Response message containing the list of storage volume luns.
class ListLunsResponse {
/// The list of luns.
core.List<Lun>? luns;
/// A token identifying a page of results from the server.
core.String? nextPageToken;
/// Locations that could not be reached.
core.List<core.String>? unreachable;
ListLunsResponse({this.luns, this.nextPageToken, this.unreachable});
ListLunsResponse.fromJson(core.Map json_)
: this(
luns:
(json_['luns'] as core.List?)
?.map(
(value) => Lun.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
nextPageToken: json_['nextPageToken'] as core.String?,
unreachable:
(json_['unreachable'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (luns != null) 'luns': luns!,
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (unreachable != null) 'unreachable': unreachable!,
};
}
/// Response with Networks with IPs
class ListNetworkUsageResponse {
/// Networks with IPs.
core.List<NetworkUsage>? networks;
ListNetworkUsageResponse({this.networks});
ListNetworkUsageResponse.fromJson(core.Map json_)
: this(
networks:
(json_['networks'] as core.List?)
?.map(
(value) => NetworkUsage.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (networks != null) 'networks': networks!,
};
}
/// Response message containing the list of networks.
class ListNetworksResponse {
/// The list of networks.
core.List<Network>? networks;
/// A token identifying a page of results from the server.
core.String? nextPageToken;
/// Locations that could not be reached.
core.List<core.String>? unreachable;
ListNetworksResponse({this.networks, this.nextPageToken, this.unreachable});
ListNetworksResponse.fromJson(core.Map json_)
: this(
networks:
(json_['networks'] as core.List?)
?.map(
(value) => Network.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
nextPageToken: json_['nextPageToken'] as core.String?,
unreachable:
(json_['unreachable'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (networks != null) 'networks': networks!,
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (unreachable != null) 'unreachable': unreachable!,
};
}
/// Response message containing the list of NFS shares.
class ListNfsSharesResponse {
/// A token identifying a page of results from the server.
core.String? nextPageToken;
/// The list of NFS shares.
core.List<NfsShare>? nfsShares;
/// Locations that could not be reached.
core.List<core.String>? unreachable;
ListNfsSharesResponse({this.nextPageToken, this.nfsShares, this.unreachable});
ListNfsSharesResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
nfsShares:
(json_['nfsShares'] as core.List?)
?.map(
(value) => NfsShare.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
unreachable:
(json_['unreachable'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (nfsShares != null) 'nfsShares': nfsShares!,
if (unreachable != null) 'unreachable': unreachable!,
};
}
/// Request for getting all available OS images.
class ListOSImagesResponse {
/// Token to retrieve the next page of results, or empty if there are no more
/// results in the list.
core.String? nextPageToken;
/// The OS images available.
core.List<OSImage>? osImages;
ListOSImagesResponse({this.nextPageToken, this.osImages});
ListOSImagesResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
osImages:
(json_['osImages'] as core.List?)
?.map(
(value) => OSImage.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (osImages != null) 'osImages': osImages!,
};
}
/// Response message for the list of provisioning quotas.
class ListProvisioningQuotasResponse {
/// Token to retrieve the next page of results, or empty if there are no more
/// results in the list.
core.String? nextPageToken;
/// The provisioning quotas registered in this project.
core.List<ProvisioningQuota>? provisioningQuotas;
ListProvisioningQuotasResponse({this.nextPageToken, this.provisioningQuotas});
ListProvisioningQuotasResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
provisioningQuotas:
(json_['provisioningQuotas'] as core.List?)
?.map(
(value) => ProvisioningQuota.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (provisioningQuotas != null) 'provisioningQuotas': provisioningQuotas!,
};
}
/// Message for response of ListSSHKeys.
class ListSSHKeysResponse {
/// Token to retrieve the next page of results, or empty if there are no more
/// results in the list.
core.String? nextPageToken;
/// The SSH keys registered in the project.
core.List<SSHKey>? sshKeys;
ListSSHKeysResponse({this.nextPageToken, this.sshKeys});
ListSSHKeysResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
sshKeys:
(json_['sshKeys'] as core.List?)
?.map(
(value) => SSHKey.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (sshKeys != null) 'sshKeys': sshKeys!,
};
}
/// Response message containing the list of volume snapshots.
class ListVolumeSnapshotsResponse {
/// A token identifying a page of results from the server.
core.String? nextPageToken;
/// Locations that could not be reached.
core.List<core.String>? unreachable;
/// The list of snapshots.
core.List<VolumeSnapshot>? volumeSnapshots;
ListVolumeSnapshotsResponse({
this.nextPageToken,
this.unreachable,
this.volumeSnapshots,
});
ListVolumeSnapshotsResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
unreachable:
(json_['unreachable'] as core.List?)
?.map((value) => value as core.String)
.toList(),
volumeSnapshots:
(json_['volumeSnapshots'] as core.List?)
?.map(
(value) => VolumeSnapshot.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (unreachable != null) 'unreachable': unreachable!,
if (volumeSnapshots != null) 'volumeSnapshots': volumeSnapshots!,
};
}
/// Response message containing the list of storage volumes.
class ListVolumesResponse {
/// A token identifying a page of results from the server.
core.String? nextPageToken;
/// Locations that could not be reached.
core.List<core.String>? unreachable;
/// The list of storage volumes.
core.List<Volume>? volumes;
ListVolumesResponse({this.nextPageToken, this.unreachable, this.volumes});
ListVolumesResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
unreachable:
(json_['unreachable'] as core.List?)
?.map((value) => value as core.String)
.toList(),
volumes:
(json_['volumes'] as core.List?)
?.map(
(value) => Volume.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (nextPageToken != null) 'nextPageToken': nextPageToken!,
if (unreachable != null) 'unreachable': unreachable!,
if (volumes != null) 'volumes': volumes!,
};
}
/// Response for LoadInstanceAuthInfo.
class LoadInstanceAuthInfoResponse {
/// List of ssh keys.
core.List<SSHKey>? sshKeys;
/// Map of username to the user account info.
core.Map<core.String, UserAccount>? userAccounts;
LoadInstanceAuthInfoResponse({this.sshKeys, this.userAccounts});
LoadInstanceAuthInfoResponse.fromJson(core.Map json_)
: this(
sshKeys:
(json_['sshKeys'] as core.List?)
?.map(
(value) => SSHKey.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
userAccounts: (json_['userAccounts']
as core.Map<core.String, core.dynamic>?)
?.map(
(key, value) => core.MapEntry(
key,
UserAccount.fromJson(
value as core.Map<core.String, core.dynamic>,
),
),
),
);
core.Map<core.String, core.dynamic> toJson() => {
if (sshKeys != null) 'sshKeys': sshKeys!,
if (userAccounts != null) 'userAccounts': userAccounts!,
};
}
/// A resource that represents a Google Cloud location.
typedef Location = $Location00;
/// Each logical network interface is effectively a network and IP pair.
class LogicalNetworkInterface {
/// Whether this interface is the default gateway for the instance.
///
/// Only one interface can be the default gateway for the instance.
core.bool? defaultGateway;
/// An identifier for the `Network`, generated by the backend.
core.String? id;
/// IP address in the network
core.String? ipAddress;
/// Name of the network
core.String? network;
/// Type of network.
/// Possible string values are:
/// - "TYPE_UNSPECIFIED" : Unspecified value.
/// - "CLIENT" : Client network, a network peered to a Google Cloud VPC.
/// - "PRIVATE" : Private network, a network local to the Bare Metal Solution
/// environment.
core.String? networkType;
LogicalNetworkInterface({
this.defaultGateway,
this.id,
this.ipAddress,
this.network,
this.networkType,
});
LogicalNetworkInterface.fromJson(core.Map json_)
: this(
defaultGateway: json_['defaultGateway'] as core.bool?,
id: json_['id'] as core.String?,
ipAddress: json_['ipAddress'] as core.String?,
network: json_['network'] as core.String?,
networkType: json_['networkType'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (defaultGateway != null) 'defaultGateway': defaultGateway!,
if (id != null) 'id': id!,
if (ipAddress != null) 'ipAddress': ipAddress!,
if (network != null) 'network': network!,
if (networkType != null) 'networkType': networkType!,
};
}
/// A storage volume logical unit number (LUN).
class Lun {
/// Display if this LUN is a boot LUN.
core.bool? bootLun;
/// Time after which LUN will be fully deleted.
///
/// It is filled only for LUNs in COOL_OFF state.
///
/// Output only.
core.String? expireTime;
/// An identifier for the LUN, generated by the backend.
core.String? id;
/// Instances this Lun is attached to.
///
/// Output only.
core.List<core.String>? instances;
/// The LUN multiprotocol type ensures the characteristics of the LUN are
/// optimized for each operating system.
/// Possible string values are:
/// - "MULTIPROTOCOL_TYPE_UNSPECIFIED" : Server has no OS specified.
/// - "LINUX" : Server with Linux OS.
core.String? multiprotocolType;
/// The name of the LUN.
///
/// Output only.
core.String? name;
/// Display if this LUN can be shared between multiple physical servers.
core.bool? shareable;
/// The size of this LUN, in GiB.
core.String? sizeGb;
/// The state of this storage volume.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The LUN is in an unknown state.
/// - "CREATING" : The LUN is being created.
/// - "UPDATING" : The LUN is being updated.
/// - "READY" : The LUN is ready for use.
/// - "DELETING" : The LUN has been requested to be deleted.
/// - "COOL_OFF" : The LUN is in cool off state. It will be deleted after
/// `expire_time`.
core.String? state;
/// The storage type for this LUN.
/// Possible string values are:
/// - "STORAGE_TYPE_UNSPECIFIED" : The storage type for this LUN is unknown.
/// - "SSD" : This storage type for this LUN is SSD.
/// - "HDD" : This storage type for this LUN is HDD.
core.String? storageType;
/// Display the storage volume for this LUN.
core.String? storageVolume;
/// The WWID for this LUN.
core.String? wwid;
Lun({
this.bootLun,
this.expireTime,
this.id,
this.instances,
this.multiprotocolType,
this.name,
this.shareable,
this.sizeGb,
this.state,
this.storageType,
this.storageVolume,
this.wwid,
});
Lun.fromJson(core.Map json_)
: this(
bootLun: json_['bootLun'] as core.bool?,
expireTime: json_['expireTime'] as core.String?,
id: json_['id'] as core.String?,
instances:
(json_['instances'] as core.List?)
?.map((value) => value as core.String)
.toList(),
multiprotocolType: json_['multiprotocolType'] as core.String?,
name: json_['name'] as core.String?,
shareable: json_['shareable'] as core.bool?,
sizeGb: json_['sizeGb'] as core.String?,
state: json_['state'] as core.String?,
storageType: json_['storageType'] as core.String?,
storageVolume: json_['storageVolume'] as core.String?,
wwid: json_['wwid'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (bootLun != null) 'bootLun': bootLun!,
if (expireTime != null) 'expireTime': expireTime!,
if (id != null) 'id': id!,
if (instances != null) 'instances': instances!,
if (multiprotocolType != null) 'multiprotocolType': multiprotocolType!,
if (name != null) 'name': name!,
if (shareable != null) 'shareable': shareable!,
if (sizeGb != null) 'sizeGb': sizeGb!,
if (state != null) 'state': state!,
if (storageType != null) 'storageType': storageType!,
if (storageVolume != null) 'storageVolume': storageVolume!,
if (wwid != null) 'wwid': wwid!,
};
}
/// A LUN(Logical Unit Number) range.
class LunRange {
/// Number of LUNs to create.
core.int? quantity;
/// The requested size of each LUN, in GB.
core.int? sizeGb;
LunRange({this.quantity, this.sizeGb});
LunRange.fromJson(core.Map json_)
: this(
quantity: json_['quantity'] as core.int?,
sizeGb: json_['sizeGb'] as core.int?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (quantity != null) 'quantity': quantity!,
if (sizeGb != null) 'sizeGb': sizeGb!,
};
}
/// A Network.
class Network {
/// The cidr of the Network.
core.String? cidr;
/// Gateway ip address.
///
/// Output only.
core.String? gatewayIp;
/// An identifier for the `Network`, generated by the backend.
core.String? id;
/// IP address configured.
core.String? ipAddress;
/// Whether network uses standard frames or jumbo ones.
core.bool? jumboFramesEnabled;
/// Labels as key value pairs.
core.Map<core.String, core.String>? labels;
/// List of physical interfaces.
core.List<core.String>? macAddress;
/// Input only.
///
/// List of mount points to attach the network to.
core.List<NetworkMountPoint>? mountPoints;
/// The resource name of this `Network`.
///
/// Resource names are schemeless URIs that follow the conventions in
/// https://cloud.google.com/apis/design/resource_names. Format:
/// `projects/{project}/locations/{location}/networks/{network}`
///
/// Output only.
core.String? name;
/// Pod name.
///
/// Pod is an independent part of infrastructure. Network can only be
/// connected to the assets (instances, nfsshares) allocated in the same pod.
///
/// Immutable.
core.String? pod;
/// List of IP address reservations in this network.
///
/// When updating this field, an error will be generated if a reservation
/// conflicts with an IP address already allocated to a physical server.
core.List<NetworkAddressReservation>? reservations;
/// IP range for reserved for services (e.g. NFS).
core.String? servicesCidr;
/// The Network state.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The Network is in an unknown state.
/// - "PROVISIONING" : The Network is provisioning.
/// - "PROVISIONED" : The Network has been provisioned.
/// - "DEPROVISIONING" : The Network is being deprovisioned.
/// - "UPDATING" : The Network is being updated.
core.String? state;
/// The type of this network.
/// Possible string values are:
/// - "TYPE_UNSPECIFIED" : Unspecified value.
/// - "CLIENT" : Client network, a network peered to a Google Cloud VPC.
/// - "PRIVATE" : Private network, a network local to the Bare Metal Solution
/// environment.
core.String? type;
/// The vlan id of the Network.
core.String? vlanId;
/// The Vrf for the Network.
///
/// Use this only if a new Vrf needs to be created.
VRF? vrf;
/// The name of a pre-existing Vrf that the network should be attached to.
///
/// Format is `vrfs/{vrf}`.
///
/// Optional.
core.String? vrfAttachment;
Network({
this.cidr,
this.gatewayIp,
this.id,
this.ipAddress,
this.jumboFramesEnabled,
this.labels,
this.macAddress,
this.mountPoints,
this.name,
this.pod,
this.reservations,
this.servicesCidr,
this.state,
this.type,
this.vlanId,
this.vrf,
this.vrfAttachment,
});
Network.fromJson(core.Map json_)
: this(
cidr: json_['cidr'] as core.String?,
gatewayIp: json_['gatewayIp'] as core.String?,
id: json_['id'] as core.String?,
ipAddress: json_['ipAddress'] as core.String?,
jumboFramesEnabled: json_['jumboFramesEnabled'] as core.bool?,
labels: (json_['labels'] as core.Map<core.String, core.dynamic>?)?.map(
(key, value) => core.MapEntry(key, value as core.String),
),
macAddress:
(json_['macAddress'] as core.List?)
?.map((value) => value as core.String)
.toList(),
mountPoints:
(json_['mountPoints'] as core.List?)
?.map(
(value) => NetworkMountPoint.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
name: json_['name'] as core.String?,
pod: json_['pod'] as core.String?,
reservations:
(json_['reservations'] as core.List?)
?.map(
(value) => NetworkAddressReservation.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
servicesCidr: json_['servicesCidr'] as core.String?,
state: json_['state'] as core.String?,
type: json_['type'] as core.String?,
vlanId: json_['vlanId'] as core.String?,
vrf:
json_.containsKey('vrf')
? VRF.fromJson(
json_['vrf'] as core.Map<core.String, core.dynamic>,
)
: null,
vrfAttachment: json_['vrfAttachment'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (cidr != null) 'cidr': cidr!,
if (gatewayIp != null) 'gatewayIp': gatewayIp!,
if (id != null) 'id': id!,
if (ipAddress != null) 'ipAddress': ipAddress!,
if (jumboFramesEnabled != null) 'jumboFramesEnabled': jumboFramesEnabled!,
if (labels != null) 'labels': labels!,
if (macAddress != null) 'macAddress': macAddress!,
if (mountPoints != null) 'mountPoints': mountPoints!,
if (name != null) 'name': name!,
if (pod != null) 'pod': pod!,
if (reservations != null) 'reservations': reservations!,
if (servicesCidr != null) 'servicesCidr': servicesCidr!,
if (state != null) 'state': state!,
if (type != null) 'type': type!,
if (vlanId != null) 'vlanId': vlanId!,
if (vrf != null) 'vrf': vrf!,
if (vrfAttachment != null) 'vrfAttachment': vrfAttachment!,
};
}
/// A network.
class NetworkAddress {
/// IPv4 address to be assigned to the server.
core.String? address;
/// Name of the existing network to use.
core.String? existingNetworkId;
/// Id of the network to use, within the same ProvisioningConfig request.
core.String? networkId;
NetworkAddress({this.address, this.existingNetworkId, this.networkId});
NetworkAddress.fromJson(core.Map json_)
: this(
address: json_['address'] as core.String?,
existingNetworkId: json_['existingNetworkId'] as core.String?,
networkId: json_['networkId'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (address != null) 'address': address!,
if (existingNetworkId != null) 'existingNetworkId': existingNetworkId!,
if (networkId != null) 'networkId': networkId!,
};
}
/// A reservation of one or more addresses in a network.
class NetworkAddressReservation {
/// The last address of this reservation block, inclusive.
///
/// I.e., for cases when reservations are only single addresses, end_address
/// and start_address will be the same. Must be specified as a single IPv4
/// address, e.g. 10.1.2.2.
core.String? endAddress;
/// A note about this reservation, intended for human consumption.
core.String? note;
/// The first address of this reservation block.
///
/// Must be specified as a single IPv4 address, e.g. 10.1.2.2.
core.String? startAddress;
NetworkAddressReservation({this.endAddress, this.note, this.startAddress});
NetworkAddressReservation.fromJson(core.Map json_)
: this(
endAddress: json_['endAddress'] as core.String?,
note: json_['note'] as core.String?,
startAddress: json_['startAddress'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (endAddress != null) 'endAddress': endAddress!,
if (note != null) 'note': note!,
if (startAddress != null) 'startAddress': startAddress!,
};
}
/// Configuration parameters for a new network.
class NetworkConfig {
/// Interconnect bandwidth.
///
/// Set only when type is CLIENT.
/// Possible string values are:
/// - "BANDWIDTH_UNSPECIFIED" : Unspecified value.
/// - "BW_1_GBPS" : 1 Gbps.
/// - "BW_2_GBPS" : 2 Gbps.
/// - "BW_5_GBPS" : 5 Gbps.
/// - "BW_10_GBPS" : 10 Gbps.
core.String? bandwidth;
/// CIDR range of the network.
core.String? cidr;
/// The GCP service of the network.
///
/// Available gcp_service are in
/// https://cloud.google.com/bare-metal/docs/bms-planning.
core.String? gcpService;
/// A transient unique identifier to identify a volume within an
/// ProvisioningConfig request.
core.String? id;
/// The JumboFramesEnabled option for customer to set.
core.bool? jumboFramesEnabled;
/// The name of the network config.
///
/// Output only.
core.String? name;
/// Service CIDR, if any.
/// Possible string values are:
/// - "SERVICE_CIDR_UNSPECIFIED" : Unspecified value.
/// - "DISABLED" : Services are disabled for the given network.
/// - "HIGH_26" : Use the highest /26 block of the network to host services.
/// - "HIGH_27" : Use the highest /27 block of the network to host services.
/// - "HIGH_28" : Use the highest /28 block of the network to host services.
core.String? serviceCidr;
/// The type of this network, either Client or Private.
/// Possible string values are:
/// - "TYPE_UNSPECIFIED" : Unspecified value.
/// - "CLIENT" : Client network, that is a network peered to a GCP VPC.
/// - "PRIVATE" : Private network, that is a network local to the BMS POD.
core.String? type;
/// User note field, it can be used by customers to add additional information
/// for the BMS Ops team .
core.String? userNote;
/// List of VLAN attachments.
///
/// As of now there are always 2 attachments, but it is going to change in the
/// future (multi vlan). Use only one of vlan_attachments or vrf
core.List<IntakeVlanAttachment>? vlanAttachments;
/// Whether the VLAN attachment pair is located in the same project.
core.bool? vlanSameProject;
/// The name of a pre-existing Vrf that the network should be attached to.
///
/// Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be
/// empty.
///
/// Optional.
core.String? vrf;
NetworkConfig({
this.bandwidth,
this.cidr,
this.gcpService,
this.id,
this.jumboFramesEnabled,
this.name,
this.serviceCidr,
this.type,
this.userNote,
this.vlanAttachments,
this.vlanSameProject,
this.vrf,
});
NetworkConfig.fromJson(core.Map json_)
: this(
bandwidth: json_['bandwidth'] as core.String?,
cidr: json_['cidr'] as core.String?,
gcpService: json_['gcpService'] as core.String?,
id: json_['id'] as core.String?,
jumboFramesEnabled: json_['jumboFramesEnabled'] as core.bool?,
name: json_['name'] as core.String?,
serviceCidr: json_['serviceCidr'] as core.String?,
type: json_['type'] as core.String?,
userNote: json_['userNote'] as core.String?,
vlanAttachments:
(json_['vlanAttachments'] as core.List?)
?.map(
(value) => IntakeVlanAttachment.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
vlanSameProject: json_['vlanSameProject'] as core.bool?,
vrf: json_['vrf'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (bandwidth != null) 'bandwidth': bandwidth!,
if (cidr != null) 'cidr': cidr!,
if (gcpService != null) 'gcpService': gcpService!,
if (id != null) 'id': id!,
if (jumboFramesEnabled != null) 'jumboFramesEnabled': jumboFramesEnabled!,
if (name != null) 'name': name!,
if (serviceCidr != null) 'serviceCidr': serviceCidr!,
if (type != null) 'type': type!,
if (userNote != null) 'userNote': userNote!,
if (vlanAttachments != null) 'vlanAttachments': vlanAttachments!,
if (vlanSameProject != null) 'vlanSameProject': vlanSameProject!,
if (vrf != null) 'vrf': vrf!,
};
}
/// Mount point for a network.
class NetworkMountPoint {
/// Network should be a default gateway.
core.bool? defaultGateway;
/// Instance to attach network to.
core.String? instance;
/// Ip address of the server.
core.String? ipAddress;
/// Logical interface to detach from.
core.String? logicalInterface;
NetworkMountPoint({
this.defaultGateway,
this.instance,
this.ipAddress,
this.logicalInterface,
});
NetworkMountPoint.fromJson(core.Map json_)
: this(
defaultGateway: json_['defaultGateway'] as core.bool?,
instance: json_['instance'] as core.String?,
ipAddress: json_['ipAddress'] as core.String?,
logicalInterface: json_['logicalInterface'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (defaultGateway != null) 'defaultGateway': defaultGateway!,
if (instance != null) 'instance': instance!,
if (ipAddress != null) 'ipAddress': ipAddress!,
if (logicalInterface != null) 'logicalInterface': logicalInterface!,
};
}
/// Network with all used IP addresses.
class NetworkUsage {
/// Network.
Network? network;
/// All used IP addresses in this network.
core.List<core.String>? usedIps;
NetworkUsage({this.network, this.usedIps});
NetworkUsage.fromJson(core.Map json_)
: this(
network:
json_.containsKey('network')
? Network.fromJson(
json_['network'] as core.Map<core.String, core.dynamic>,
)
: null,
usedIps:
(json_['usedIps'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (network != null) 'network': network!,
if (usedIps != null) 'usedIps': usedIps!,
};
}
/// A NFS export entry.
class NfsExport {
/// Allow dev flag in NfsShare AllowedClientsRequest.
core.bool? allowDev;
/// Allow the setuid flag.
core.bool? allowSuid;
/// A CIDR range.
core.String? cidr;
/// Either a single machine, identified by an ID, or a comma-separated list of
/// machine IDs.
core.String? machineId;
/// Network to use to publish the export.
core.String? networkId;
/// Disable root squashing, which is a feature of NFS.
///
/// Root squash is a special mapping of the remote superuser (root) identity
/// when using identity authentication.
core.bool? noRootSquash;
/// Export permissions.
/// Possible string values are:
/// - "PERMISSIONS_UNSPECIFIED" : Unspecified value.
/// - "READ_ONLY" : Read-only permission.
/// - "READ_WRITE" : Read-write permission.
core.String? permissions;
NfsExport({
this.allowDev,
this.allowSuid,
this.cidr,
this.machineId,
this.networkId,
this.noRootSquash,
this.permissions,
});
NfsExport.fromJson(core.Map json_)
: this(
allowDev: json_['allowDev'] as core.bool?,
allowSuid: json_['allowSuid'] as core.bool?,
cidr: json_['cidr'] as core.String?,
machineId: json_['machineId'] as core.String?,
networkId: json_['networkId'] as core.String?,
noRootSquash: json_['noRootSquash'] as core.bool?,
permissions: json_['permissions'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (allowDev != null) 'allowDev': allowDev!,
if (allowSuid != null) 'allowSuid': allowSuid!,
if (cidr != null) 'cidr': cidr!,
if (machineId != null) 'machineId': machineId!,
if (networkId != null) 'networkId': networkId!,
if (noRootSquash != null) 'noRootSquash': noRootSquash!,
if (permissions != null) 'permissions': permissions!,
};
}
/// An NFS share.
class NfsShare {
/// List of allowed access points.
core.List<AllowedClient>? allowedClients;
/// An identifier for the NFS share, generated by the backend.
///
/// This is the same value as nfs_share_id and will replace it in the future.
///
/// Output only.
core.String? id;
/// Labels as key value pairs.
core.Map<core.String, core.String>? labels;
/// The name of the NFS share.
///
/// Immutable.
core.String? name;
/// An identifier for the NFS share, generated by the backend.
///
/// This field will be deprecated in the future, use `id` instead.
///
/// Output only.
core.String? nfsShareId;
/// Pod name.
///
/// Pod is an independent part of infrastructure. NFSShare can only be
/// connected to the assets (networks, instances) allocated in the same pod.
///
/// Immutable.
core.String? pod;
/// The requested size, in GiB.
core.String? requestedSizeGib;
/// The state of the NFS share.
///
/// Output only.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The share is in an unknown state.
/// - "PROVISIONED" : The share has been provisioned.
/// - "CREATING" : The NFS Share is being created.
/// - "UPDATING" : The NFS Share is being updated.
/// - "DELETING" : The NFS Share has been requested to be deleted.
core.String? state;
/// The storage type of the underlying volume.
///
/// Immutable.
/// Possible string values are:
/// - "STORAGE_TYPE_UNSPECIFIED" : The storage type for this volume is
/// unknown.
/// - "SSD" : The storage type for this volume is SSD.
/// - "HDD" : This storage type for this volume is HDD.
core.String? storageType;
/// The underlying volume of the share.
///
/// Created automatically during provisioning.
///
/// Output only.
core.String? volume;
NfsShare({
this.allowedClients,
this.id,
this.labels,
this.name,
this.nfsShareId,
this.pod,
this.requestedSizeGib,
this.state,
this.storageType,
this.volume,
});
NfsShare.fromJson(core.Map json_)
: this(
allowedClients:
(json_['allowedClients'] as core.List?)
?.map(
(value) => AllowedClient.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
id: json_['id'] as core.String?,
labels: (json_['labels'] as core.Map<core.String, core.dynamic>?)?.map(
(key, value) => core.MapEntry(key, value as core.String),
),
name: json_['name'] as core.String?,
nfsShareId: json_['nfsShareId'] as core.String?,
pod: json_['pod'] as core.String?,
requestedSizeGib: json_['requestedSizeGib'] as core.String?,
state: json_['state'] as core.String?,
storageType: json_['storageType'] as core.String?,
volume: json_['volume'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (allowedClients != null) 'allowedClients': allowedClients!,
if (id != null) 'id': id!,
if (labels != null) 'labels': labels!,
if (name != null) 'name': name!,
if (nfsShareId != null) 'nfsShareId': nfsShareId!,
if (pod != null) 'pod': pod!,
if (requestedSizeGib != null) 'requestedSizeGib': requestedSizeGib!,
if (state != null) 'state': state!,
if (storageType != null) 'storageType': storageType!,
if (volume != null) 'volume': volume!,
};
}
/// Operation System image.
class OSImage {
/// Instance types this image is applicable to.
///
/// [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
core.List<core.String>? applicableInstanceTypes;
/// OS Image code.
core.String? code;
/// OS Image description.
core.String? description;
/// OS Image's unique name.
///
/// Output only.
core.String? name;
/// Network templates that can be used with this OS Image.
core.List<core.String>? supportedNetworkTemplates;
OSImage({
this.applicableInstanceTypes,
this.code,
this.description,
this.name,
this.supportedNetworkTemplates,
});
OSImage.fromJson(core.Map json_)
: this(
applicableInstanceTypes:
(json_['applicableInstanceTypes'] as core.List?)
?.map((value) => value as core.String)
.toList(),
code: json_['code'] as core.String?,
description: json_['description'] as core.String?,
name: json_['name'] as core.String?,
supportedNetworkTemplates:
(json_['supportedNetworkTemplates'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (applicableInstanceTypes != null)
'applicableInstanceTypes': applicableInstanceTypes!,
if (code != null) 'code': code!,
if (description != null) 'description': description!,
if (name != null) 'name': name!,
if (supportedNetworkTemplates != null)
'supportedNetworkTemplates': supportedNetworkTemplates!,
};
}
/// This resource represents a long-running operation that is the result of a
/// network API call.
class Operation {
/// If the value is `false`, it means the operation is still in progress.
///
/// If `true`, the operation is completed, and either `error` or `response` is
/// available.
core.bool? done;
/// The error result of the operation in case of failure or cancellation.
Status? error;
/// Service-specific metadata associated with the operation.
///
/// It typically contains progress information and common metadata such as
/// create time. Some services might not provide such metadata. Any method
/// that returns a long-running operation should document the metadata type,
/// if any.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object?>? metadata;
/// The server-assigned name, which is only unique within the same service
/// that originally returns it.
///
/// If you use the default HTTP mapping, the `name` should be a resource name
/// ending with `operations/{unique_id}`.
core.String? name;
/// The normal, successful response of the operation.
///
/// If the original method returns no data on success, such as `Delete`, the
/// response is `google.protobuf.Empty`. If the original method is standard
/// `Get`/`Create`/`Update`, the response should be the resource. For other
/// methods, the response should have the type `XxxResponse`, where `Xxx` is
/// the original method name. For example, if the original method name is
/// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object?>? response;
Operation({this.done, this.error, this.metadata, this.name, this.response});
Operation.fromJson(core.Map json_)
: this(
done: json_['done'] as core.bool?,
error:
json_.containsKey('error')
? Status.fromJson(
json_['error'] as core.Map<core.String, core.dynamic>,
)
: null,
metadata:
json_.containsKey('metadata')
? json_['metadata'] as core.Map<core.String, core.dynamic>
: null,
name: json_['name'] as core.String?,
response:
json_.containsKey('response')
? json_['response'] as core.Map<core.String, core.dynamic>
: null,
);
core.Map<core.String, core.dynamic> toJson() => {
if (done != null) 'done': done!,
if (error != null) 'error': error!,
if (metadata != null) 'metadata': metadata!,
if (name != null) 'name': name!,
if (response != null) 'response': response!,
};
}
/// A provisioning configuration.
class ProvisioningConfig {
/// URI to Cloud Console UI view of this provisioning config.
///
/// Output only.
core.String? cloudConsoleUri;
/// The user-defined identifier of the provisioning config.
///
/// Optional.
core.String? customId;
/// Email provided to send a confirmation with provisioning config to.
///
/// Deprecated in favour of email field in request messages.
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
core.String? email;
/// A service account to enable customers to access instance credentials upon
/// handover.
core.String? handoverServiceAccount;
/// Instances to be created.
core.List<InstanceConfig>? instances;
/// Location name of this ProvisioningConfig.
///
/// It is optional only for Intake UI transition period.
///
/// Optional.
core.String? location;
/// The system-generated name of the provisioning config.
///
/// This follows the UUID format.
///
/// Output only.
core.String? name;
/// Networks to be created.
core.List<NetworkConfig>? networks;
/// Pod name.
///
/// Pod is an independent part of infrastructure. Instance can be connected to
/// the assets (networks, volumes, nfsshares) allocated in the same pod only.
///
/// Optional.
core.String? pod;
/// State of ProvisioningConfig.
///
/// Output only.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : State wasn't specified.
/// - "DRAFT" : ProvisioningConfig is a draft and can be freely modified.
/// - "SUBMITTED" : ProvisioningConfig was already submitted and cannot be
/// modified.
/// - "PROVISIONING" : ProvisioningConfig was in the provisioning state.
/// Initially this state comes from the work order table in big query when
/// SNOW is used. Later this field can be set by the work order API.
/// - "PROVISIONED" : ProvisioningConfig was provisioned, meaning the
/// resources exist.
/// - "VALIDATED" : ProvisioningConfig was validated. A validation tool will
/// be run to set this state.
/// - "CANCELLED" : ProvisioningConfig was canceled.
/// - "FAILED" : The request is submitted for provisioning, with error return.
core.String? state;
/// Optional status messages associated with the FAILED state.
core.String? statusMessage;
/// A generated ticket id to track provisioning request.
core.String? ticketId;
/// Last update timestamp.
///
/// Output only.
core.String? updateTime;
/// Volumes to be created.
core.List<VolumeConfig>? volumes;
/// If true, VPC SC is enabled for the cluster.
core.bool? vpcScEnabled;
ProvisioningConfig({
this.cloudConsoleUri,
this.customId,
this.email,
this.handoverServiceAccount,
this.instances,
this.location,
this.name,
this.networks,
this.pod,
this.state,
this.statusMessage,
this.ticketId,
this.updateTime,
this.volumes,
this.vpcScEnabled,
});
ProvisioningConfig.fromJson(core.Map json_)
: this(
cloudConsoleUri: json_['cloudConsoleUri'] as core.String?,
customId: json_['customId'] as core.String?,
email: json_['email'] as core.String?,
handoverServiceAccount: json_['handoverServiceAccount'] as core.String?,
instances:
(json_['instances'] as core.List?)
?.map(
(value) => InstanceConfig.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
location: json_['location'] as core.String?,
name: json_['name'] as core.String?,
networks:
(json_['networks'] as core.List?)
?.map(
(value) => NetworkConfig.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
pod: json_['pod'] as core.String?,
state: json_['state'] as core.String?,
statusMessage: json_['statusMessage'] as core.String?,
ticketId: json_['ticketId'] as core.String?,
updateTime: json_['updateTime'] as core.String?,
volumes:
(json_['volumes'] as core.List?)
?.map(
(value) => VolumeConfig.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
vpcScEnabled: json_['vpcScEnabled'] as core.bool?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (cloudConsoleUri != null) 'cloudConsoleUri': cloudConsoleUri!,
if (customId != null) 'customId': customId!,
if (email != null) 'email': email!,
if (handoverServiceAccount != null)
'handoverServiceAccount': handoverServiceAccount!,
if (instances != null) 'instances': instances!,
if (location != null) 'location': location!,
if (name != null) 'name': name!,
if (networks != null) 'networks': networks!,
if (pod != null) 'pod': pod!,
if (state != null) 'state': state!,
if (statusMessage != null) 'statusMessage': statusMessage!,
if (ticketId != null) 'ticketId': ticketId!,
if (updateTime != null) 'updateTime': updateTime!,
if (volumes != null) 'volumes': volumes!,
if (vpcScEnabled != null) 'vpcScEnabled': vpcScEnabled!,
};
}
/// A provisioning quota for a given project.
class ProvisioningQuota {
/// The asset type of this provisioning quota.
/// Possible string values are:
/// - "ASSET_TYPE_UNSPECIFIED" : The unspecified type.
/// - "ASSET_TYPE_SERVER" : The server asset type.
/// - "ASSET_TYPE_STORAGE" : The storage asset type.
/// - "ASSET_TYPE_NETWORK" : The network asset type.
core.String? assetType;
/// The available count of the provisioning quota.
core.int? availableCount;
/// The gcp service of the provisioning quota.
core.String? gcpService;
/// Instance quota.
InstanceQuota? instanceQuota;
/// The specific location of the provisioining quota.
core.String? location;
/// The name of the provisioning quota.
///
/// Output only.
core.String? name;
/// Network bandwidth, Gbps
core.String? networkBandwidth;
/// Server count.
core.String? serverCount;
/// Storage size (GB).
core.String? storageGib;
ProvisioningQuota({
this.assetType,
this.availableCount,
this.gcpService,
this.instanceQuota,
this.location,
this.name,
this.networkBandwidth,
this.serverCount,
this.storageGib,
});
ProvisioningQuota.fromJson(core.Map json_)
: this(
assetType: json_['assetType'] as core.String?,
availableCount: json_['availableCount'] as core.int?,
gcpService: json_['gcpService'] as core.String?,
instanceQuota:
json_.containsKey('instanceQuota')
? InstanceQuota.fromJson(
json_['instanceQuota'] as core.Map<core.String, core.dynamic>,
)
: null,
location: json_['location'] as core.String?,
name: json_['name'] as core.String?,
networkBandwidth: json_['networkBandwidth'] as core.String?,
serverCount: json_['serverCount'] as core.String?,
storageGib: json_['storageGib'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (assetType != null) 'assetType': assetType!,
if (availableCount != null) 'availableCount': availableCount!,
if (gcpService != null) 'gcpService': gcpService!,
if (instanceQuota != null) 'instanceQuota': instanceQuota!,
if (location != null) 'location': location!,
if (name != null) 'name': name!,
if (networkBandwidth != null) 'networkBandwidth': networkBandwidth!,
if (serverCount != null) 'serverCount': serverCount!,
if (storageGib != null) 'storageGib': storageGib!,
};
}
/// QOS policy parameters.
class QosPolicy {
/// The bandwidth permitted by the QOS policy, in gbps.
core.double? bandwidthGbps;
QosPolicy({this.bandwidthGbps});
QosPolicy.fromJson(core.Map json_)
: this(bandwidthGbps: (json_['bandwidthGbps'] as core.num?)?.toDouble());
core.Map<core.String, core.dynamic> toJson() => {
if (bandwidthGbps != null) 'bandwidthGbps': bandwidthGbps!,
};
}
/// Message requesting to perform reimage operation on a server.
class ReimageInstanceRequest {
/// Name of the KMS crypto key version used to encrypt the initial passwords.
///
/// The key has to have ASYMMETRIC_DECRYPT purpose. Format is
/// `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
///
/// Optional.
core.String? kmsKeyVersion;
/// The OS image code of the image which will be used in the reimage
/// operation.
///
/// Required.
core.String? osImage;
/// List of SSH Keys used during reimaging an instance.
///
/// Optional.
core.List<core.String>? sshKeys;
ReimageInstanceRequest({this.kmsKeyVersion, this.osImage, this.sshKeys});
ReimageInstanceRequest.fromJson(core.Map json_)
: this(
kmsKeyVersion: json_['kmsKeyVersion'] as core.String?,
osImage: json_['osImage'] as core.String?,
sshKeys:
(json_['sshKeys'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (kmsKeyVersion != null) 'kmsKeyVersion': kmsKeyVersion!,
if (osImage != null) 'osImage': osImage!,
if (sshKeys != null) 'sshKeys': sshKeys!,
};
}
/// Message requesting rename of a server.
class RenameInstanceRequest {
/// The new `id` of the instance.
///
/// Required.
core.String? newInstanceId;
RenameInstanceRequest({this.newInstanceId});
RenameInstanceRequest.fromJson(core.Map json_)
: this(newInstanceId: json_['newInstanceId'] as core.String?);
core.Map<core.String, core.dynamic> toJson() => {
if (newInstanceId != null) 'newInstanceId': newInstanceId!,
};
}
/// Message requesting rename of a server.
class RenameNetworkRequest {
/// The new `id` of the network.
///
/// Required.
core.String? newNetworkId;
RenameNetworkRequest({this.newNetworkId});
RenameNetworkRequest.fromJson(core.Map json_)
: this(newNetworkId: json_['newNetworkId'] as core.String?);
core.Map<core.String, core.dynamic> toJson() => {
if (newNetworkId != null) 'newNetworkId': newNetworkId!,
};
}
/// Message requesting rename of a server.
class RenameNfsShareRequest {
/// The new `id` of the nfsshare.
///
/// Required.
core.String? newNfsshareId;
RenameNfsShareRequest({this.newNfsshareId});
RenameNfsShareRequest.fromJson(core.Map json_)
: this(newNfsshareId: json_['newNfsshareId'] as core.String?);
core.Map<core.String, core.dynamic> toJson() => {
if (newNfsshareId != null) 'newNfsshareId': newNfsshareId!,
};
}
/// Message requesting rename of a server.
class RenameVolumeRequest {
/// The new `id` of the volume.
///
/// Required.
core.String? newVolumeId;
RenameVolumeRequest({this.newVolumeId});
RenameVolumeRequest.fromJson(core.Map json_)
: this(newVolumeId: json_['newVolumeId'] as core.String?);
core.Map<core.String, core.dynamic> toJson() => {
if (newVolumeId != null) 'newVolumeId': newVolumeId!,
};
}
/// Message requesting to reset a server.
typedef ResetInstanceRequest = $Empty;
/// Request for emergency resize Volume.
class ResizeVolumeRequest {
/// New Volume size, in GiB.
core.String? sizeGib;
ResizeVolumeRequest({this.sizeGib});
ResizeVolumeRequest.fromJson(core.Map json_)
: this(sizeGib: json_['sizeGib'] as core.String?);
core.Map<core.String, core.dynamic> toJson() => {
if (sizeGib != null) 'sizeGib': sizeGib!,
};
}
/// Message for restoring a volume snapshot.
typedef RestoreVolumeSnapshotRequest = $Empty;
/// An SSH key, used for authorizing with the interactive serial console
/// feature.
class SSHKey {
/// The name of this SSH key.
///
/// Currently, the only valid value for the location is "global".
///
/// Output only.
core.String? name;
/// The public SSH key.
///
/// This must be in OpenSSH .authorized_keys format.
core.String? publicKey;
SSHKey({this.name, this.publicKey});
SSHKey.fromJson(core.Map json_)
: this(
name: json_['name'] as core.String?,
publicKey: json_['publicKey'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (name != null) 'name': name!,
if (publicKey != null) 'publicKey': publicKey!,
};
}
/// Details about snapshot space reservation and usage on the storage volume.
class SnapshotReservationDetail {
/// The space on this storage volume reserved for snapshots, shown in GiB.
core.String? reservedSpaceGib;
/// Percent of the total Volume size reserved for snapshot copies.
///
/// Enabling snapshots requires reserving 20% or more of the storage volume
/// space for snapshots. Maximum reserved space for snapshots is 40%. Setting
/// this field will effectively set snapshot_enabled to true.
core.int? reservedSpacePercent;
/// The amount, in GiB, of available space in this storage volume's reserved
/// snapshot space.
core.String? reservedSpaceRemainingGib;
/// The percent of snapshot space on this storage volume actually being used
/// by the snapshot copies.
///
/// This value might be higher than 100% if the snapshot copies have
/// overflowed into the data portion of the storage volume.
core.int? reservedSpaceUsedPercent;
SnapshotReservationDetail({
this.reservedSpaceGib,
this.reservedSpacePercent,
this.reservedSpaceRemainingGib,
this.reservedSpaceUsedPercent,
});
SnapshotReservationDetail.fromJson(core.Map json_)
: this(
reservedSpaceGib: json_['reservedSpaceGib'] as core.String?,
reservedSpacePercent: json_['reservedSpacePercent'] as core.int?,
reservedSpaceRemainingGib:
json_['reservedSpaceRemainingGib'] as core.String?,
reservedSpaceUsedPercent:
json_['reservedSpaceUsedPercent'] as core.int?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (reservedSpaceGib != null) 'reservedSpaceGib': reservedSpaceGib!,
if (reservedSpacePercent != null)
'reservedSpacePercent': reservedSpacePercent!,
if (reservedSpaceRemainingGib != null)
'reservedSpaceRemainingGib': reservedSpaceRemainingGib!,
if (reservedSpaceUsedPercent != null)
'reservedSpaceUsedPercent': reservedSpaceUsedPercent!,
};
}
/// Message requesting to start a server.
typedef StartInstanceRequest = $Empty;
/// The `Status` type defines a logical error model that is suitable for
/// different programming environments, including REST APIs and RPC APIs.
///
/// It is used by [gRPC](https://github.com/grpc). Each `Status` message
/// contains three pieces of data: error code, error message, and error details.
/// You can find out more about this error model and how to work with it in the
/// [API Design Guide](https://cloud.google.com/apis/design/errors).
typedef Status = $Status00;
/// Message requesting to stop a server.
typedef StopInstanceRequest = $Empty;
/// Request for SubmitProvisioningConfig.
class SubmitProvisioningConfigRequest {
/// Email provided to send a confirmation with provisioning config to.
///
/// Optional.
core.String? email;
/// The ProvisioningConfig to create.
///
/// Required.
ProvisioningConfig? provisioningConfig;
SubmitProvisioningConfigRequest({this.email, this.provisioningConfig});
SubmitProvisioningConfigRequest.fromJson(core.Map json_)
: this(
email: json_['email'] as core.String?,
provisioningConfig:
json_.containsKey('provisioningConfig')
? ProvisioningConfig.fromJson(
json_['provisioningConfig']
as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() => {
if (email != null) 'email': email!,
if (provisioningConfig != null) 'provisioningConfig': provisioningConfig!,
};
}
/// Response for SubmitProvisioningConfig.
class SubmitProvisioningConfigResponse {
/// The submitted provisioning config.
ProvisioningConfig? provisioningConfig;
SubmitProvisioningConfigResponse({this.provisioningConfig});
SubmitProvisioningConfigResponse.fromJson(core.Map json_)
: this(
provisioningConfig:
json_.containsKey('provisioningConfig')
? ProvisioningConfig.fromJson(
json_['provisioningConfig']
as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() => {
if (provisioningConfig != null) 'provisioningConfig': provisioningConfig!,
};
}
/// User account provisioned for the customer.
class UserAccount {
/// Encrypted initial password value.
core.String? encryptedPassword;
/// KMS CryptoKey Version used to encrypt the password.
core.String? kmsKeyVersion;
UserAccount({this.encryptedPassword, this.kmsKeyVersion});
UserAccount.fromJson(core.Map json_)
: this(
encryptedPassword: json_['encryptedPassword'] as core.String?,
kmsKeyVersion: json_['kmsKeyVersion'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (encryptedPassword != null) 'encryptedPassword': encryptedPassword!,
if (kmsKeyVersion != null) 'kmsKeyVersion': kmsKeyVersion!,
};
}
/// A network VRF.
class VRF {
/// The name of the VRF.
core.String? name;
/// The QOS policy applied to this VRF.
///
/// The value is only meaningful when all the vlan attachments have the same
/// QoS. This field should not be used for new integrations, use vlan
/// attachment level qos instead. The field is left for
/// backward-compatibility.
QosPolicy? qosPolicy;
/// The possible state of VRF.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The unspecified state.
/// - "PROVISIONING" : The vrf is provisioning.
/// - "PROVISIONED" : The vrf is provisioned.
core.String? state;
/// The list of VLAN attachments for the VRF.
core.List<VlanAttachment>? vlanAttachments;
VRF({this.name, this.qosPolicy, this.state, this.vlanAttachments});
VRF.fromJson(core.Map json_)
: this(
name: json_['name'] as core.String?,
qosPolicy:
json_.containsKey('qosPolicy')
? QosPolicy.fromJson(
json_['qosPolicy'] as core.Map<core.String, core.dynamic>,
)
: null,
state: json_['state'] as core.String?,
vlanAttachments:
(json_['vlanAttachments'] as core.List?)
?.map(
(value) => VlanAttachment.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() => {
if (name != null) 'name': name!,
if (qosPolicy != null) 'qosPolicy': qosPolicy!,
if (state != null) 'state': state!,
if (vlanAttachments != null) 'vlanAttachments': vlanAttachments!,
};
}
/// VLAN attachment details.
class VlanAttachment {
/// The identifier of the attachment within vrf.
///
/// Immutable.
core.String? id;
/// The name of the vlan attachment within vrf.
///
/// This is of the form
/// projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
///
/// Optional.
core.String? interconnectAttachment;
/// Input only.
///
/// Pairing key.
core.String? pairingKey;
/// The peer IP of the attachment.
core.String? peerIp;
/// The peer vlan ID of the attachment.
core.String? peerVlanId;
/// The QOS policy applied to this VLAN attachment.
///
/// This value should be preferred to using qos at vrf level.
QosPolicy? qosPolicy;
/// The router IP of the attachment.
core.String? routerIp;
VlanAttachment({
this.id,
this.interconnectAttachment,
this.pairingKey,
this.peerIp,
this.peerVlanId,
this.qosPolicy,
this.routerIp,
});
VlanAttachment.fromJson(core.Map json_)
: this(
id: json_['id'] as core.String?,
interconnectAttachment: json_['interconnectAttachment'] as core.String?,
pairingKey: json_['pairingKey'] as core.String?,
peerIp: json_['peerIp'] as core.String?,
peerVlanId: json_['peerVlanId'] as core.String?,
qosPolicy:
json_.containsKey('qosPolicy')
? QosPolicy.fromJson(
json_['qosPolicy'] as core.Map<core.String, core.dynamic>,
)
: null,
routerIp: json_['routerIp'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (id != null) 'id': id!,
if (interconnectAttachment != null)
'interconnectAttachment': interconnectAttachment!,
if (pairingKey != null) 'pairingKey': pairingKey!,
if (peerIp != null) 'peerIp': peerIp!,
if (peerVlanId != null) 'peerVlanId': peerVlanId!,
if (qosPolicy != null) 'qosPolicy': qosPolicy!,
if (routerIp != null) 'routerIp': routerIp!,
};
}
/// A storage volume.
class Volume {
/// Is the Volume attached at at least one instance.
///
/// This field is a lightweight counterpart of `instances` field. It is filled
/// in List responses as well.
///
/// Output only.
core.bool? attached;
/// The size, in GiB, that this storage volume has expanded as a result of an
/// auto grow policy.
///
/// In the absence of auto-grow, the value is 0.
core.String? autoGrownSizeGib;
/// Whether this volume is a boot volume.
///
/// A boot volume is one which contains a boot LUN.
///
/// Output only.
core.bool? bootVolume;
/// The current size of this storage volume, in GiB, including space reserved
/// for snapshots.
///
/// This size might be different than the requested size if the storage volume
/// has been configured with auto grow or auto shrink.
core.String? currentSizeGib;
/// Additional emergency size that was requested for this Volume, in GiB.
///
/// current_size_gib includes this value.
core.String? emergencySizeGib;
/// Time after which volume will be fully deleted.
///
/// It is filled only for volumes in COOLOFF state.
///
/// Output only.
core.String? expireTime;
/// An identifier for the `Volume`, generated by the backend.
core.String? id;
/// Instances this Volume is attached to.
///
/// This field is set only in Get requests.
///
/// Output only.
core.List<core.String>? instances;
/// Labels as key value pairs.
core.Map<core.String, core.String>? labels;
/// Maximum size volume can be expanded to in case of evergency, in GiB.
core.String? maxSizeGib;
/// The resource name of this `Volume`.
///
/// Resource names are schemeless URIs that follow the conventions in
/// https://cloud.google.com/apis/design/resource_names. Format:
/// `projects/{project}/locations/{location}/volumes/{volume}`
///
/// Output only.
core.String? name;
/// Input only.
///
/// User-specified notes for new Volume. Used to provision Volumes that
/// require manual intervention.
core.String? notes;
/// Originally requested size, in GiB.
core.String? originallyRequestedSizeGib;
/// Performance tier of the Volume.
///
/// Default is SHARED.
///
/// Immutable.
/// Possible string values are:
/// - "VOLUME_PERFORMANCE_TIER_UNSPECIFIED" : Value is not specified.
/// - "VOLUME_PERFORMANCE_TIER_SHARED" : Regular volumes, shared aggregates.
/// - "VOLUME_PERFORMANCE_TIER_ASSIGNED" : Assigned aggregates.
/// - "VOLUME_PERFORMANCE_TIER_HT" : High throughput aggregates.
/// - "VOLUME_PERFORMANCE_TIER_QOS2_PERFORMANCE" : QoS 2.0 high performance
/// storage.
core.String? performanceTier;
/// Pod name.
///
/// Pod is an independent part of infrastructure. Volume can only be connected
/// to the instances allocated in the same pod.
///
/// Immutable.
core.String? pod;
/// Storage protocol for the Volume.
///
/// Output only.
/// Possible string values are:
/// - "PROTOCOL_UNSPECIFIED" : Value is not specified.
/// - "FIBRE_CHANNEL" : Fibre Channel protocol.
/// - "NFS" : NFS protocol means Volume is a NFS Share volume. Such volumes
/// cannot be manipulated via Volumes API.
core.String? protocol;
/// The space remaining in the storage volume for new LUNs, in GiB, excluding
/// space reserved for snapshots.
core.String? remainingSpaceGib;
/// The requested size of this storage volume, in GiB.
core.String? requestedSizeGib;
/// The behavior to use when snapshot reserved space is full.
/// Possible string values are:
/// - "SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED" : The unspecified behavior.
/// - "DISABLED" : Don't delete any snapshots. This disables new snapshot
/// creation, as long as the snapshot reserved space is full.
/// - "OLDEST_FIRST" : Delete the oldest snapshots first.
/// - "NEWEST_FIRST" : Delete the newest snapshots first.
core.String? snapshotAutoDeleteBehavior;
/// Whether snapshots are enabled.
core.bool? snapshotEnabled;
/// Details about snapshot space reservation and usage on the storage volume.
SnapshotReservationDetail? snapshotReservationDetail;
/// The state of this storage volume.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The storage volume is in an unknown state.
/// - "CREATING" : The storage volume is being created.
/// - "READY" : The storage volume is ready for use.
/// - "DELETING" : The storage volume has been requested to be deleted.
/// - "UPDATING" : The storage volume is being updated.
/// - "COOL_OFF" : The storage volume is in cool off state. It will be deleted
/// after `expire_time`.
core.String? state;
/// The storage type for this volume.
/// Possible string values are:
/// - "STORAGE_TYPE_UNSPECIFIED" : The storage type for this volume is
/// unknown.
/// - "SSD" : The storage type for this volume is SSD.
/// - "HDD" : This storage type for this volume is HDD.
core.String? storageType;
/// The workload profile for the volume.
/// Possible string values are:
/// - "WORKLOAD_PROFILE_UNSPECIFIED" : The workload profile is in an unknown
/// state.
/// - "GENERIC" : The workload profile is generic.
/// - "HANA" : The workload profile is hana.
core.String? workloadProfile;
Volume({
this.attached,
this.autoGrownSizeGib,
this.bootVolume,
this.currentSizeGib,
this.emergencySizeGib,
this.expireTime,
this.id,
this.instances,
this.labels,
this.maxSizeGib,
this.name,
this.notes,
this.originallyRequestedSizeGib,
this.performanceTier,
this.pod,
this.protocol,
this.remainingSpaceGib,
this.requestedSizeGib,
this.snapshotAutoDeleteBehavior,
this.snapshotEnabled,
this.snapshotReservationDetail,
this.state,
this.storageType,
this.workloadProfile,
});
Volume.fromJson(core.Map json_)
: this(
attached: json_['attached'] as core.bool?,
autoGrownSizeGib: json_['autoGrownSizeGib'] as core.String?,
bootVolume: json_['bootVolume'] as core.bool?,
currentSizeGib: json_['currentSizeGib'] as core.String?,
emergencySizeGib: json_['emergencySizeGib'] as core.String?,
expireTime: json_['expireTime'] as core.String?,
id: json_['id'] as core.String?,
instances:
(json_['instances'] as core.List?)
?.map((value) => value as core.String)
.toList(),
labels: (json_['labels'] as core.Map<core.String, core.dynamic>?)?.map(
(key, value) => core.MapEntry(key, value as core.String),
),
maxSizeGib: json_['maxSizeGib'] as core.String?,
name: json_['name'] as core.String?,
notes: json_['notes'] as core.String?,
originallyRequestedSizeGib:
json_['originallyRequestedSizeGib'] as core.String?,
performanceTier: json_['performanceTier'] as core.String?,
pod: json_['pod'] as core.String?,
protocol: json_['protocol'] as core.String?,
remainingSpaceGib: json_['remainingSpaceGib'] as core.String?,
requestedSizeGib: json_['requestedSizeGib'] as core.String?,
snapshotAutoDeleteBehavior:
json_['snapshotAutoDeleteBehavior'] as core.String?,
snapshotEnabled: json_['snapshotEnabled'] as core.bool?,
snapshotReservationDetail:
json_.containsKey('snapshotReservationDetail')
? SnapshotReservationDetail.fromJson(
json_['snapshotReservationDetail']
as core.Map<core.String, core.dynamic>,
)
: null,
state: json_['state'] as core.String?,
storageType: json_['storageType'] as core.String?,
workloadProfile: json_['workloadProfile'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (attached != null) 'attached': attached!,
if (autoGrownSizeGib != null) 'autoGrownSizeGib': autoGrownSizeGib!,
if (bootVolume != null) 'bootVolume': bootVolume!,
if (currentSizeGib != null) 'currentSizeGib': currentSizeGib!,
if (emergencySizeGib != null) 'emergencySizeGib': emergencySizeGib!,
if (expireTime != null) 'expireTime': expireTime!,
if (id != null) 'id': id!,
if (instances != null) 'instances': instances!,
if (labels != null) 'labels': labels!,
if (maxSizeGib != null) 'maxSizeGib': maxSizeGib!,
if (name != null) 'name': name!,
if (notes != null) 'notes': notes!,
if (originallyRequestedSizeGib != null)
'originallyRequestedSizeGib': originallyRequestedSizeGib!,
if (performanceTier != null) 'performanceTier': performanceTier!,
if (pod != null) 'pod': pod!,
if (protocol != null) 'protocol': protocol!,
if (remainingSpaceGib != null) 'remainingSpaceGib': remainingSpaceGib!,
if (requestedSizeGib != null) 'requestedSizeGib': requestedSizeGib!,
if (snapshotAutoDeleteBehavior != null)
'snapshotAutoDeleteBehavior': snapshotAutoDeleteBehavior!,
if (snapshotEnabled != null) 'snapshotEnabled': snapshotEnabled!,
if (snapshotReservationDetail != null)
'snapshotReservationDetail': snapshotReservationDetail!,
if (state != null) 'state': state!,
if (storageType != null) 'storageType': storageType!,
if (workloadProfile != null) 'workloadProfile': workloadProfile!,
};
}
/// Configuration parameters for a new volume.
class VolumeConfig {
/// The GCP service of the storage volume.
///
/// Available gcp_service are in
/// https://cloud.google.com/bare-metal/docs/bms-planning.
core.String? gcpService;
/// A transient unique identifier to identify a volume within an
/// ProvisioningConfig request.
core.String? id;
/// LUN ranges to be configured.
///
/// Set only when protocol is PROTOCOL_FC.
core.List<LunRange>? lunRanges;
/// Machine ids connected to this volume.
///
/// Set only when protocol is PROTOCOL_FC.
core.List<core.String>? machineIds;
/// The name of the volume config.
///
/// Output only.
core.String? name;
/// NFS exports.
///
/// Set only when protocol is PROTOCOL_NFS.
core.List<NfsExport>? nfsExports;
/// Performance tier of the Volume.
///
/// Default is SHARED.
/// Possible string values are:
/// - "VOLUME_PERFORMANCE_TIER_UNSPECIFIED" : Value is not specified.
/// - "VOLUME_PERFORMANCE_TIER_SHARED" : Regular volumes, shared aggregates.
/// - "VOLUME_PERFORMANCE_TIER_ASSIGNED" : Assigned aggregates.
/// - "VOLUME_PERFORMANCE_TIER_HT" : High throughput aggregates.
/// - "VOLUME_PERFORMANCE_TIER_QOS2_PERFORMANCE" : QoS 2.0 high performance
/// storage.
core.String? performanceTier;
/// Volume protocol.
/// Possible string values are:
/// - "PROTOCOL_UNSPECIFIED" : Unspecified value.
/// - "PROTOCOL_FC" : Fibre channel.
/// - "PROTOCOL_NFS" : Network file system.
core.String? protocol;
/// The requested size of this volume, in GB.
core.int? sizeGb;
/// Whether snapshots should be enabled.
core.bool? snapshotsEnabled;
/// The type of this Volume.
/// Possible string values are:
/// - "TYPE_UNSPECIFIED" : The unspecified type.
/// - "FLASH" : This Volume is on flash.
/// - "DISK" : This Volume is on disk.
core.String? type;
/// User note field, it can be used by customers to add additional information
/// for the BMS Ops team .
core.String? userNote;
VolumeConfig({
this.gcpService,
this.id,
this.lunRanges,
this.machineIds,
this.name,
this.nfsExports,
this.performanceTier,
this.protocol,
this.sizeGb,
this.snapshotsEnabled,
this.type,
this.userNote,
});
VolumeConfig.fromJson(core.Map json_)
: this(
gcpService: json_['gcpService'] as core.String?,
id: json_['id'] as core.String?,
lunRanges:
(json_['lunRanges'] as core.List?)
?.map(
(value) => LunRange.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
machineIds:
(json_['machineIds'] as core.List?)
?.map((value) => value as core.String)
.toList(),
name: json_['name'] as core.String?,
nfsExports:
(json_['nfsExports'] as core.List?)
?.map(
(value) => NfsExport.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
performanceTier: json_['performanceTier'] as core.String?,
protocol: json_['protocol'] as core.String?,
sizeGb: json_['sizeGb'] as core.int?,
snapshotsEnabled: json_['snapshotsEnabled'] as core.bool?,
type: json_['type'] as core.String?,
userNote: json_['userNote'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (gcpService != null) 'gcpService': gcpService!,
if (id != null) 'id': id!,
if (lunRanges != null) 'lunRanges': lunRanges!,
if (machineIds != null) 'machineIds': machineIds!,
if (name != null) 'name': name!,
if (nfsExports != null) 'nfsExports': nfsExports!,
if (performanceTier != null) 'performanceTier': performanceTier!,
if (protocol != null) 'protocol': protocol!,
if (sizeGb != null) 'sizeGb': sizeGb!,
if (snapshotsEnabled != null) 'snapshotsEnabled': snapshotsEnabled!,
if (type != null) 'type': type!,
if (userNote != null) 'userNote': userNote!,
};
}
/// A snapshot of a volume.
///
/// Only boot volumes can have snapshots.
class VolumeSnapshot {
/// The creation time of the snapshot.
///
/// Output only.
core.String? createTime;
/// The description of the snapshot.
core.String? description;
/// An identifier for the snapshot, generated by the backend.
///
/// Output only.
core.String? id;
/// The name of the snapshot.
core.String? name;
/// The name of the volume which this snapshot belongs to.
///
/// Output only.
core.String? storageVolume;
/// The type of the snapshot which indicates whether it was scheduled or
/// manual/ad-hoc.
///
/// Output only.
/// Possible string values are:
/// - "SNAPSHOT_TYPE_UNSPECIFIED" : Type is not specified.
/// - "AD_HOC" : Snapshot was taken manually by user.
/// - "SCHEDULED" : Snapshot was taken automatically as a part of a snapshot
/// schedule.
core.String? type;
VolumeSnapshot({
this.createTime,
this.description,
this.id,
this.name,
this.storageVolume,
this.type,
});
VolumeSnapshot.fromJson(core.Map json_)
: this(
createTime: json_['createTime'] as core.String?,
description: json_['description'] as core.String?,
id: json_['id'] as core.String?,
name: json_['name'] as core.String?,
storageVolume: json_['storageVolume'] as core.String?,
type: json_['type'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() => {
if (createTime != null) 'createTime': createTime!,
if (description != null) 'description': description!,
if (id != null) 'id': id!,
if (name != null) 'name': name!,
if (storageVolume != null) 'storageVolume': storageVolume!,
if (type != null) 'type': type!,
};
}